Skip to content

Update README.md #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SohaibBaig1243 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down Expand Up @@ -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 <your-forked-repo-url> to download it locally.
- Create a New Branch: Run git checkout -b <branch-name> 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 <branch-name>.
- 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!