summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPietro Albini <pietro@pietroalbini.org>2019-07-11 15:06:39 +0200
committerPietro Albini <pietro@pietroalbini.org>2019-07-13 21:13:52 +0200
commit6c69a5ee75f18ecaa8b5cb7a320ed2cde94fb711 (patch)
tree45f7554f256f10fa1f25147877eeb7c5b07718e5 /README.md
parent14a42ebabfd56eb50447d8d8c8d4e2b1235cf1c7 (diff)
add the add-person subcommand
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8123c80..d5f41d1 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,17 @@ data. You can run the checks locally with the `check` command:
$ cargo run check
```
+### Adding a person to the repository
+
+It's possible to fetch the public information present in a GitHub profile and
+store it in a person's TOML file. To do that you need to have the
+`GITHUB_TOKEN` environment variable setup with a valid personal access token,
+and you need to run the command:
+
+```
+$ cargo run add-person <username>
+```
+
### Querying information out of the repository
There are a few CLI commands that allow you to get some information generated