Commit cb134ae
Changed files (2)
src/present-badges.ts
@@ -36,7 +36,6 @@ export const presentBadges = (
userBadges = mergeBadges(userBadges, newBadges)
}
-
if (compact) {
for (const presenter of presenters) {
if (!presenter.tiers) {
README.md
@@ -18,7 +18,7 @@ or [here](https://github.com/antongolub).
Here is how to add my badges to your profile:
- Star this repository.
-- Create `your-username/your-username` 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
@@ -44,13 +44,19 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Update My Badges
- run: npx update-my-badges ${{github.repository_owner}} --repo=${{ github.repository }}
+ run: npx update-my-badges ${{github.repository_owner}}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
- Start **my-badges** workflow, or wait for it to run automatically.
+You can also perform these steps manually:
+- Go to `username/username` local repo.
+- Run `npx update-my-badges --user <username> --token=<token> --dryrun`.
+- Verify `my-badges` and `readme.md` changes.
+- Push a commit: `git add -- . ':!data' && git commit -m "chore: update my-bagdes"`.
+
## Configuration
| Param | ENV alias | Description | Default |
@@ -60,7 +66,7 @@ jobs:
| `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 to git | |
+| `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` | |
| `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 | |