Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Mar 5, 2024
1 parent fc01d19 commit b56786a
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:

So, you want to contribute to this project! That's awesome. However, before
doing so, please read the following simple steps how to contribute. This will
make the life easier and will avoid wasting time on things which are not
doing so, please read the following simple steps explaining how to contribute. This will
make life easier and help avoid wasting time on things that are not
requested. :sparkles:

## Discuss the changes before doing them
Expand All @@ -15,9 +15,9 @@ requested. :sparkles:
system, Node.JS version etc.), screenshots (so we can see what you are
seeing).

- It is recommended to wait for feedback before continuing to next steps.
- It is recommended to wait for feedback before continuing the next steps.
However, if the issue is clear (e.g. a typo) and the fix is simple, you can
continue and fix it.
continue to fix it.

## Fixing issues
- Fork the project in your account and create a branch with your fix:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016-23 Bloggify <[email protected]> (https://bloggify.org)
Copyright (c) 2016-24 Bloggify <[email protected]> (https://bloggify.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ yarn add github-calendar




## :question: Get Help

There are few ways to get help:
Expand All @@ -138,6 +139,8 @@ There are few ways to get help:





## :memo: Documentation


Expand Down Expand Up @@ -195,17 +198,16 @@ Have an idea? Found a bug? See [how to contribute][contributing].
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `@pengliheng/github-report`
- `@jiratki/gatsby-theme-minimal-portfolio`
- `github-alike-calendar`
- `react-ts-github-calendar`
- `@axetroy/react-github-calendar`
- `@dotnetthailand/gatsby-theme-minimal-portfolio`
- `github-calendar-element`
- `github-contributions-react`
- `@jiratki/gatsby-theme-minimal-portfolio`
- `@pengliheng/github-report`
- `@philipwhiuk/react-github-calendar`
- `github-alike-calendar`
- `github-calendar-element`
- `github-calendar-web-component`
- `@totoroot/hugo-github-calendar`
- `github-contributions-react`
- `react-ts-github-calendar`



Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b56786a

Please sign in to comment.