Skip to content

Commit 18ce222

Browse files
committed
Add description
1 parent 128cc5e commit 18ce222

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,14 @@ They are the same and will install Nightly Builds tagged with the current date.
3232
vfox use crystal@20240420
3333
```
3434

35+
Some environment variables are served as following:
36+
37+
| Environment variables | Default value | Description |
38+
| --------------------- | --------------------- | ---------------- |
39+
| GITHUB_TOKEN | "" | GitHub Token |
40+
| GITHUB_URL | "https://github.com/" | GitHub proxy URL |
41+
3542
## Note
3643

3744
This plugin uses the GitHub API to retrieve available versions of Crystal. It is recommended to modify the `~/.version-fox/plugin/crystal/lib/util.lua` file to set your personal GitHub token for a higher rate limit before formal use.
38-
https://github.com/yanecc/vfox-crystal/blob/04c6c68b29ca33301a9005c5ddf9b3ea5bb3cb1c/lib/util.lua#L72-L73
45+
https://github.com/yanecc/vfox-crystal/blob/128cc5ed1c9c5a49d89b3a6f58ce686180d0af60/lib/util.lua#L72-L73

0 commit comments

Comments
 (0)