diff --git a/README.md b/README.md index aeafefe..25b4e24 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ # Github Contributions on Canvas [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] - A tool for drawing a heat-map of Github contributions on HTML Canvas. - This module is used for drawing user contributions in [this project](https://github-contributions.now.sh). ## Install - ```sh $ npm install github-contributions-canvas ``` @@ -55,3 +52,15 @@ Sallar Kaboli © [MIT License](LICENSE) [travis-url]: https://travis-ci.com/sallar/github-contributions-canvas [daviddm-image]: https://david-dm.org/sallar/github-contributions-canvas.svg?theme=shields.io [daviddm-url]: https://david-dm.org/sallar/github-contributions-canvas + +@@ How To Contribute + +- Fork the Repository: Click the "Fork" button to create your own copy of the repository. +- Clone the Repository: Use the command git clone to download it locally. +- Create a New Branch: Run git checkout -b to work on a separate branch. +- Make Your Changes: Modify code, fix bugs, or update documentation as needed. +- Commit Your Changes: Use git commit -m "Descriptive message about your changes" to save your changes locally. +- Push to GitHub: Push the changes to your forked repository with git push origin . +- Create a Pull Request (PR): Go to the original repository and open a pull request explaining your changes. +- Address Feedback: Be ready to discuss and make additional changes if needed during the review process. +- Contributions of all types are welcome—thank you for helping improve the project!