diff --git a/CHANGELOG.md b/CHANGELOG.md index 56125b2..e603384 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,24 @@ # credit +## 1.4.0 (2021-02-05) + +#### Added + +- A config file can now be defined at your `XDG_CONFIG_HOME`, which by default + is `$HOME/.config/credit.toml`. At the moment the only field is `token`: + +```toml +token = "abc123" # Your Github Access Token. +``` + +With this, you no longer need to pass `--token` on the command line. + +#### Changed + +- The dependency `reqwest` has been removed in favour of raw `curl`. This + reduces dependency count by about 100 crates, and the final stripped binary + size is now 1.5mb, down from about 4.5mb. + ## 1.3.0 (2020-08-24) #### Added diff --git a/Cargo.toml b/Cargo.toml index d49712c..ba16e9c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "credit" -version = "1.3.0" +version = "1.4.0" authors = ["Colin Woodbury "] edition = "2018" description = "A fast tool for measuring Github repository contributions." diff --git a/README.md b/README.md index 9ba9079..e8445b1 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Use `credit` to find out: - [JSON Output](#json-output) - [Large Projects](#large-projects) - [Developer Rankings](#developer-rankings) + - [Configuration](#configuration) - [FAQ](#faq) - [How accurate is this?](#how-accurate-is-this) - [Can I see commit counts too?](#can-i-see-commit-counts-too) @@ -200,6 +201,17 @@ There are currently 18518 Github users in Switzerland. As with `repo`, the `--json` flag can be used to output JSON data instead. +## Configuration + +A configuration file can be specified at your `XDG_CONFIG_HOME`, which by +default is `$HOME/.config/credit.toml`. + + +```toml +# Your Github Access Token. With this set, you need not pass `--token` on the command line. +token = "abc123" +``` + ## FAQ ### How accurate is this?