trystant
commented
7 years ago From the requirements associated with a README.md from Thinkful:
GitHub README
- The name of your app at the top of the file
- A link to the live project
- Documentation of your API.
- Screenshot(s) of your app. This makes your app description much easier to understand.
- A summary section. This should have a concise explanation of what your app does. Try to frame this from the standpoint of what the user does, or what the app enables for the user.
- A section on the technology used. Student examples:
- https://github.com/jon-wade/pw-vault,
- https://github.com/jon-wade/incite-news,
- https://github.com/bvellek/aeropress-me-app#aeropressme-%EF%B8%8F
Installation instructions for developers unfamiliar with Chrome extension development would be helpful.