Skip to content

Instantly share code, notes, and snippets.

@SoldierCorp
Created January 3, 2019 04:00
Show Gist options
  • Save SoldierCorp/03a9867063ae0b4a71ec90f9071324d3 to your computer and use it in GitHub Desktop.
Save SoldierCorp/03a9867063ae0b4a71ec90f9071324d3 to your computer and use it in GitHub Desktop.
Example of readme.md file

This guide is a template that contains steps to install the project, technologies used, folder structure, etc.

  • /: Page to show the home or main page
  • /blog: Page for blog
  • /contact: Page for contact

Technologies used

Dependencies

Guide to continue developing

Dependencies

  • Webpack and webpack dev server: Install them with yarn global add webpack webpack-dev-server

Branches

  • master main branch, used for production. ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment