Skip to content

Commit b0ddc16

Browse files
committed
Updated docs
1 parent 708f5eb commit b0ddc16

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ I'd be curious to see your calendar with all your commits. Ping me on Twitter ([
2020
- [Importing and deleting commits](#importing-and-deleting-commits)
2121
- [Importing all the commits from GitHub and BitBucket](#importing-all-the-commits-from-github-and-bitbucket)
2222
- [What about the GitHub Contributions calendar?](#what-about-the-github-contributions-calendar)
23+
2324
- [Documentation](#documentation)
2425
- [How to contribute](#how-to-contribute)
2526

27+
2628
## :cloud: Installation
2729

2830
You can install the package globally and use it as command line tool:
@@ -173,39 +175,24 @@ Since it's a js file, you can `require` any other modules there.
173175
[`git-stats-html`](https://github.com/IonicaBizau/git-stats-html) interprets the JSON data and generates an HTML file. Example:
174176

175177
```sh
176-
177178
# Install git-stats-html
178-
179179
npm install -g git-stats-html
180180

181-
182-
183181
# Export the data from the last year (generate out.html)
184-
185182
git-stats --raw | git-stats-html -o out.html
186183

187-
188-
189184
# Export data since 2015 (save the results in out.html)
190-
191185
git-stats --since '1 January 2015' --raw | ./bin/git-stats-html -o out.html --big
192-
193186
```
194187

195188
After we have the HTML file, we can generate an image file using [`pageres`](https://github.com/sindresorhus/pageres) by [**@sindresorhus**](https://github.com/sindresorhus/):
196189

197190
```sh
198-
199191
# Install pageres
200-
201192
npm install -g pageres-cli
202193

203-
204-
205194
# Generate the image from HTML
206-
207195
pageres out.html 775x250
208-
209196
```
210197

211198
## Cross-platform compatibility
@@ -243,6 +230,15 @@ g1.ansiCalendar({
243230
});
244231
```
245232

233+
## :question: Get Help
234+
235+
There are few ways to get help:
236+
237+
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
238+
2. For bug reports and feature requests, open issues. :bug:
239+
3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
240+
241+
246242
## :memo: Documentation
247243

248244
For full API reference, see the [DOCUMENTATION.md][docs] file.
@@ -251,6 +247,7 @@ For full API reference, see the [DOCUMENTATION.md][docs] file.
251247

252248
- [*A GitHub-like contributions calendar, but locally, with all your git commits*, The Changelog](https://changelog.com/github-like-contributions-calendar-locally-git-commits/)
253249

250+
254251
## :yum: How to contribute
255252
Have an idea? Found a bug? See [how to contribute][contributing].
256253

0 commit comments

Comments
 (0)