Skip to content

Commit

Permalink
docs: add configuration section
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandre-abrioux committed Nov 11, 2024
1 parent eae0fe2 commit 08b9e9b
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 28 deletions.
19 changes: 2 additions & 17 deletions .github/github-profile-toolbox.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,12 @@ tools:
Language:
- html5
- css3
- php
- javascript
- typescript
- cplusplus
- rust
Tools:
- git
- github
- gitlab
- debian
- archlinux
- nixos
- npm
- yarn
- pnpm
- githubactions
IDEs:
- visualstudiocode
- jetbrains
- webstorm
- rustrover
- vim
- neovim
- gnuemacs
- nano
- neovim
54 changes: 43 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ Giving the following configuration passed as an input to the GitHub action:

```yaml
tools:
IDE:
- jetbrains
- neovim
Language:
- html5
- css3
- javascript
- cplusplus
- rust
- php
Tools:
- git
- github
- githubactions
IDEs:
- visualstudiocode
- jetbrains
- neovim
```
; you would get the following output:
Expand All @@ -32,9 +36,27 @@ Here is a
You can find an example
[here](https://github.com/alexandre-abrioux/alexandre-abrioux/blob/main/README.md?plain=1).

- Add the following workflow file to your profile repository:
- Add the configuration file to your GitHub profile repository:
`.github/github-profile-toolbox.yaml`

`.github/workflows/update-toolbox.yaml`
```yaml
tools:
Language:
- html5
- css3
- javascript
Tools:
- git
- github
- githubactions
IDEs:
- visualstudiocode
- jetbrains
- neovim
```

- Add the following workflow file to your GitHub profile repository:
`.github/workflows/update-toolbox.yaml`

```yaml
name: Update Toolbox
Expand Down Expand Up @@ -63,12 +85,22 @@ jobs:
reviewers: ${{ github.actor }}
```

- Go to your profile repository and under "Settings > Actions > General > Workflow permissions"
activate the option "Allow GitHub Actions to create and approve pull requests".

You can find an example
[here](https://github.com/alexandre-abrioux/alexandre-abrioux/blob/main/.github/workflows/update-toolbox.yaml).

- In your GitHub profile repository, under "Settings > Actions > General > Workflow permissions",
activate the option "Allow GitHub Actions to create and approve pull requests".

You're all set!

### Configuration

This GitHub action uses https://shields.io to generate icons in your profile's README,
and `shield.io` itself uses https://simpleicons.org/ provide logos for brands.
You can find a list of all available brand names over here:
https://github.com/simple-icons/simple-icons/blob/develop/slugs.md.
Use the `Brand slug` name to furnish your configuration file.

### Override defaults

Use the following input parameters to customize it for your use case:
Expand Down

0 comments on commit 08b9e9b

Please sign in to comment.