Skip to content

Commit 9937da5

Browse files
committed
Introduce Elegant Git badge
A user may mention that Elegant Git is used for a project by adding a badge into the project's README file. And, in order to unify the badge and simplify the adding, the "Show your assistant" page is added. It provides copy/paste badge for .md and .rst files.
1 parent 3dfb846 commit 9937da5

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
[bl]: https://github.com/bees-hive/elegant-git/actions?workflow=Quality+pipeline
1414
[db]: https://readthedocs.org/projects/elegant-git/badge/?version=latest
1515
[dl]: https://elegant-git.bees-hive.org/en/latest/?badge=latest
16+
[eb]: https://img.shields.io/badge/assistant-Elegant%20Git-000000.svg
17+
[el]: https://github.com/bees-hive/elegant-git
1618

1719
# Elegant Git
1820
Elegant Git is an assistant who carefully automates routine work with Git.
@@ -28,7 +30,8 @@ click on the picture :point_down::point_down::point_down: to see a demo.
2830

2931
[![][sb]][sl] [![][ab]][al]
3032

31-
[![][bb]][bl] [![][db]][dl] [![][0b]][0l]
33+
[![][bb]][bl] [![][db]][dl] [![][0b]][0l] [![][eb]][el]
34+
3235

3336
---
3437

docs/show-your-assistant.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Show your assistant
2+
3+
If you use Elegant Git - it means that you have a great assistant for your daily routine. And you
4+
can say about it by including a badge to your README file. It looks like this:
5+
6+
[![git assistant: Elegant Git](https://img.shields.io/badge/assistant-Elegant%20Git-000000.svg)](https://github.com/bees-hive/elegant-git)
7+
8+
Add the following line to project’s README.md:
9+
10+
```md
11+
12+
[![assistant: Elegant Git](https://img.shields.io/badge/assistant-Elegant%20Git-000000.svg)](https://github.com/bees-hive/elegant-git)
13+
14+
```
15+
16+
Add the following line to project’s README.rst:
17+
18+
```rst
19+
20+
.. image:: https://img.shields.io/badge/assistant-Elegant%20Git-000000.svg
21+
:target: https://github.com/bees-hive/elegant-git
22+
23+
```
24+
25+
You are awesome!

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ nav:
99
- Getting started: getting-started.md
1010
- Configuration: configuration.md
1111
- Commands: commands.md
12+
- Show your assistant: show-your-assistant.md
1213
- Release notes: https://github.com/bees-hive/elegant-git/releases
1314
- License: licence.md
1415

0 commit comments

Comments
 (0)