A little info about your project and/ or overview that explains what the project is about.
🌟Hello everyone! This is the repository of my package on Python "sync-folders".🌟
A helpful checklist to gauge how your README is coming along:
- One-liner explaining the purpose of the module
- Necessary background context & links
- Potentially unfamiliar terms link to informative sources
- Clear, runnable example of usage
- Installation instructions
- Extensive API documentation
- Performs cognitive funneling
- Caveats and limitations mentioned up-front
- Doesn't rely on images to relay critical information
- License
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
Build status of continus integration i.e. travis, appveyor etc.
Here you can see build status of continuous integration/continuous deployment:
Other badges
Include logo/demo screenshot etc.
Built with
What makes your project stand out?
With my package you can sync two folders, manage logs files, delete empty folders and old files, read and create zip-archives.
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Provide step by step series of examples and explanations about how to get a development env running.
If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
As tables
Describe and show how to run the tests with code examples.
As screenshot or 😄I give you the link to GitHub Actions, where you can see all my tests.
Let people know how they can contribute into your project. A contributing guideline will be a big plus.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Also look at the CONTRIBUTING.md.
Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.
MIT © Yourname