Skip to content

Commit 40c5063

Browse files
committed
📝 Add some info in various docs
Signed-off-by: mathieu.brunot <[email protected]>
1 parent acd1a76 commit 40c5063

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Please, write [commit messages that make sense](http://tbaggery.com/2008/04/19/a
1717

1818
You MUST use the `develop` branch as the base of your Pull Request.
1919

20-
You MUST update the `CHANGELOG.md`, either manually or using [gitmoji-changelog](https://github.com/frinyvonnick/gitmoji-changelog).
20+
You MUST update the `CHANGELOG.md`, either manually by respecting [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog) or using [gitmoji-changelog](https://github.com/frinyvonnick/gitmoji-changelog).
2121

2222
If possible, use [gitmoji](https://gitmoji.carloscuesta.me/) in your commit message to ease code reviews.
2323

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
39
<a name="0.0.1"></a>
410
## 0.0.1 (2019-11-02)
511

README.md

+17-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
# Email Signature Generator
99

10-
:alembic: [POC] Test project for generating email signature using templates.
10+
> :alembic: **Experimental** Test project for generating email signature using templates.
1111
1212
The aim for this project is to provide a simple web application to generate an email signature based on a template.
1313
The key features to develop are:
@@ -20,27 +20,37 @@ The key features to develop are:
2020
* allow multiple file formats for input and output (text only, HTML, Markdown)
2121
* add a Visit Card generator and PDF export
2222

23+
2324
For reference, the concept is similar to the following websites though our aim is to provide a simple solution to host privately:
2425
* https://webapp.wisestamp.com/
2526
* https://mysignature.io/editor
2627
* https://www.hubspot.fr/email-signature-generator
2728

29+
2830
## :rocket: Usage
2931

3032
**TODO**
3133

32-
## :busts_in_silhouette: Contributing
34+
## :bust_in_silhouette: Author
35+
36+
**Monogramm**
37+
38+
* Website: https://www.monogramm.io
39+
* Github: [@Monogramm](https://github.com/Monogramm)
40+
41+
## :handshake: Contributing
3342

34-
Contributions, issues and feature requests are welcome.<br />
35-
Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues) if you want to contribute.<br />
36-
[Check the contributing guide](./CONTRIBUTING.md).<br />
43+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/Monogramm/email_signature_generator/issues).
44+
[Check the contributing guide](./.github/CONTRIBUTING.md).<br />
3745

3846
## :thumbsup: Show your support
3947

40-
Please :star: this repository if this project helped you!
48+
Give a :star: if this project helped you!
4149

4250
## :page_facing_up: License
4351

4452
Copyright © 2019 [Monogramm](https://github.com/Monogramm).<br />
45-
This project is [AGPL v3][uri_license] licensed.
53+
This project is [AGPL v3](uri_license) licensed.
4654

55+
***
56+
_This README was generated with :heart: by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 commit comments

Comments
 (0)