Skip to content

Commit 21b9445

Browse files
committed
docs: add badges to README
1 parent 0ac64ee commit 21b9445

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44

55
# Glim
66

7+
[![Tests Status][badge-test]][test] [![Online Demo][badge-online-demo]][demo] [![Last Commit][badge-last-commit]][commits]
8+
9+
[badge-test]: https://github.com/Xevion/Glim/actions/workflows/test.yaml/badge.svg
10+
[badge-online-demo]: https://img.shields.io/github/deployments/Xevion/Glim/production?logo=railway&label=deploy&labelColor=13111c
11+
[badge-last-commit]: https://img.shields.io/github/last-commit/Xevion/Glim
12+
[test]: https://github.com/Xevion/Glim/actions/workflows/test.yaml
13+
[demo]: https://gh.xevion.dev/Xevion/Glim.png
14+
[commits]: https://github.com/Xevion/Glim/commits/master
15+
16+
<!-- [badge-coverage]: https://coveralls.io/repos/github/Xevion/Glim/badge.svg?branch=master -->
17+
<!-- [coverage]: https://coveralls.io/github/Xevion/Glim?branch=master -->
18+
719
Glīm (pronounced 'gleem') is a command-line tool and web-server for generating beautiful, dynamic cards for your GitHub repositories.
820

921
The name comes from an Old English word meaning a small gleam of light, representing how each card captures the brilliance of your project.
@@ -43,22 +55,6 @@ For most users, **no token is required** as Glim works perfectly with public rep
4355
4456
If you'd like to use a token anyways, you can create one in the **Settings** > **Developer settings** > **Personal access tokens** > [Fine-grained tokens](https://github.com/settings/personal-access-tokens) page. I strongly recommend that you do not click on any scopes, and do not change the default Repository access from 'Public repositories'.
4557
46-
## Building
47-
48-
To build the project from source, you'll need to have Rust and Cargo installed.
49-
50-
1. Clone the repository:
51-
```bash
52-
git clone https://github.com/Xevion/glim.git
53-
cd glim
54-
cargo build --release
55-
```
56-
2. The executable will be located in `target/release/glim`.
57-
58-
## Contributing
59-
60-
Contributions are welcome! Please feel free to open an issue or submit a pull request.
61-
6258
## License
6359
6460
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)