Skip to content

Commit

Permalink
Some better information about the project
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacalz committed Dec 23, 2021
1 parent 145c7b3 commit c2a2e1a
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2021, Jacob Alzén
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Ghdstats

Ghdstats is a simple, but very fast, tool to fetch download counts from GitHub releases.
You just give it a user, or a user and repository, and it gets all the necessary details.

## Usage

The general usage of the program works like this:
```
$ ghdstats [user] [repository, optional]
```

As an example, you can get all the data for [fyne-io/calculator](https://github.com/fyne-io/calculator):
```
$ ghdstats fyne-io calculator
```

Or, you can alternatively get data for all repositories in [fyne-io](https://github.com/fyne-io):
```
$ ghdstats fyne-io
```

## Performance

The goal here is to be as fast as possible but still keeping very readable code.
All repositories for a user are downloaded and processed concurrently for better performance on multicore systems.

## Inspiration and resoning

A lot of the inspiration for this came from https://github.com/mmilidoni/github-downloads-count.
I wanted to creat something faster that could run without having any Python-stuff installed
and easily be compiled for multiple platforms.

0 comments on commit c2a2e1a

Please sign in to comment.