update readme.md - Githubissues

DuckDuckLib / duckduckLib

Firefox search extension that turns "safe search" and regional filtering OFF by default so you can decide what you want to see.

GNU Affero General Public License v3.0

1 stars 0 forks source link

update readme.md #21

Open CouldBeThis opened 3 years ago

CouldBeThis commented 3 years ago

[ ] introduction
- [ ] overview
- [ ] website #20
- [ ] motivations & use cases
- [ ] learning value
[ ] install/platforms/releases
- [ ] firefox #1
- [ ] screenshots
- [ ] release notes #16
- [ ] not available for chrome, safari etc
[ ] detailed instructions and info
- [ ] screenshots
- [ ] privacy policy #5
[ ] support/problems
- [ ] roadmap
- [ ] wishlist
[ ] sources and history
[ ] license

CouldBeThis commented 3 years ago

Github docs suggest in Formatting your README this structure:

Project name
Description "clear, short, and to the point. Describe the importance of your project, and what it does.:
Table of Contents (optional)
Installation
Usage
Contributing (larger projects)
Credits
License

Your README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis, outlined below.