Commit 543f1f6
Changed files (1)
README.md
@@ -19,7 +19,9 @@ Here is how to add my badges to your profile:
- Star this repository.
-
+
Create `your-username/your-username` [GH profile repository](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
+
- In `README.md` add the following code:
```html
@@ -54,17 +56,25 @@ jobs:
## Configuration
-| Param | ENV alias | Description | Default |
-|-----------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
-| `token` | `GITHUB_TOKEN` | Auth token | |
-| `user` | `GITHUB_USER` | Username | |
-| `repo` | `GITHUB_REPO` | Repository name to push badges | `{user/user}` |
-| `data` | | Path to JSON to generate badges. If empty, required data will be obtained from the GH API | |
-| `size` | | Badge size for README.md, px | 64 |
-| `dryrun` | | Generate badges, but skip pushing them to git | |
-| `pick` | | List of badges to pick. Pass `--pick="a-commit,ab-commit,revert-revert-commit"` to generate only the specified entries. If empty gets all of them | |
-| `omit` | | List of badges to exclude. For example, if you're too shy to flex your stars: `--omit:stars-100,stars-500,stars-1000` or even shorter `--omit:stars-*` | |
-| `compact` | | Represent the highest tier badges in README.md. For example, If you have both `stars-100` and `stars-500` achievements, only the last one will be shown | |
+| Param | ENV alias | Description | Default |
+|---------|----------------|--------------------------------|---------------|
+| `token` | `GITHUB_TOKEN` | Auth token | |
+| `user` | `GITHUB_USER` | Username | |
+| `repo` | `GITHUB_REPO` | Repository name to push badges | `{user/user}` |
+
+<details>
+<summary>Additional params</summary>
+
+| Param | ENV alias | Description | Default |
+|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| `data` | | Path to JSON to generate badges. If empty, required data will be obtained from the GH API | |
+| `size` | | Badge size for README.md, px | 64 |
+| `dryrun` | | Generate badges, but skip pushing them to git | |
+| `pick` | | List of badges to pick. Pass `--pick="a-commit,ab-commit,revert-revert-commit"` to generate only the specified entries. If empty gets all of them | |
+| `omit` | | List of badges to exclude. For example, if you're too shy to flex your stars: `--omit:stars-100,stars-500,stars-1000` or even shorter `--omit:stars-*` | |
+| `compact` | | Represent the highest tier badges in README.md. For example, If you have both `stars-100` and `stars-500` achievements, only the last one will be shown | |
+
+</details>
### Manual Run