Skip to content

Commit 32a33da

Browse files
author
aliyaman
committed
updated.
1 parent 6b7be69 commit 32a33da

File tree

5 files changed

+26
-19
lines changed

5 files changed

+26
-19
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Since we use Bitbucket, we needed something like this and I wanted to share it p
55
# Emoji Support
66
If comments comply with conventional commit rules, they are supported with emoji.
77

8+
```json
9+
[
810
"feat": "",
911
"fix": "🚀",
1012
"build": "💚",
@@ -16,7 +18,9 @@ If comments comply with conventional commit rules, they are supported with emoji
1618
"test": "🧪",
1719
"merge": "🎉",
1820
"revert": "⏪️"
19-
21+
]
22+
````
23+
2024
# Installing
2125

2226
pip install changelogs-cli
@@ -26,19 +30,19 @@ If comments comply with conventional commit rules, they are supported with emoji
2630
First, let's get into the current your repository.
2731

2832
Example;
29-
cd /home/repository/
33+
```cd /home/repository/```
3034

3135
Example usage is as follows.
32-
changelogs example/commits/ (this should be commit link to show reference on changelogs md.)
36+
changelogs ```example/commits/``` (this should be commit link to show reference on changelogs md.)
3337

3438

3539
# Demo
3640

3741
i will use this repo for example ; https://github.com/qoomon/git-conventional-commits
3842

39-
<img src="https://raw.githubusercontent.com/AliYmn/changelogs/master/images/ex1.png">
43+
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex1.png">
4044

41-
<img src="https://raw.githubusercontent.com/AliYmn/changelogs/master/images/ex2.png">
45+
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex2.png">
4246

4347
---
4448

File renamed without changes.

index.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Checklogs Generator
2-
Hey! This Package is a CLI package that creates automatic checklogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
1+
# Changelogs Generator
2+
Hey! This Package is a [changelogs-cli](https://pypi.org/project/changelogs-cli/) package that creates automatic changelogs that supports [Conventional Commits.](https://www.conventionalcommits.org/en/v1.0.0/)
33
Since we use Bitbucket, we needed something like this and I wanted to share it publicly in case you need it too.
44

55
# Emoji Support
66
If comments comply with conventional commit rules, they are supported with emoji.
77

8+
```json
9+
[
810
"feat": "✅",
911
"fix": "🚀",
1012
"build": "💚",
@@ -16,30 +18,31 @@ If comments comply with conventional commit rules, they are supported with emoji
1618
"test": "🧪",
1719
"merge": "🎉",
1820
"revert": "⏪️"
19-
21+
]
22+
````
23+
2024
# Installing
2125

22-
pip install checklogs
23-
https://pypi.org/project/checklogs/
26+
pip install changelogs-cli
2427

2528
# Example
2629

2730
First, let's get into the current your repository.
2831

2932
Example;
30-
cd /home/repository/
33+
```cd /home/repository/```
3134

3235
Example usage is as follows.
33-
checklogs example/commits/ (this should be commit link to show reference on checklogs md.)
36+
changelogs ```example/commits/``` (this should be commit link to show reference on changelogs md.)
3437

3538

3639
# Demo
3740

3841
i will use this repo for example ; https://github.com/qoomon/git-conventional-commits
3942

40-
<img src="https://raw.githubusercontent.com/AliYmn/checklogs/master/images/ex1.png">
43+
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex1.png">
4144

42-
<img src="https://raw.githubusercontent.com/AliYmn/checklogs/master/images/ex2.png">
45+
<img src="https://raw.githubusercontent.com/AliYmn/changelog/master/images/ex2.png">
4346

4447
---
4548

setup.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@
1111

1212
setup(
1313
name="changelogs-cli",
14-
version="3.0.0",
14+
version="1.0.0",
1515
author="Ali Yaman",
1616
author_email="aliymn.db@gmail.com",
1717
description="Generates git changelog for Conventional Commits",
1818
license="MIT",
1919
long_description_content_type="text/markdown",
2020
long_description=README,
2121
keywords="Generates git changelog for Conventional Commits",
22-
packages=['changelogs'],
23-
url='https://github.com/AliYmn/changelogs',
24-
download_url='https://github.com/AliYmn/changelogs',
22+
packages=['changelog'],
23+
url='https://github.com/AliYmn/changelog',
24+
download_url='https://github.com/AliYmn/changelog',
2525
install_requires=[],
2626
include_package_data=True,
2727
zip_safe=False,
@@ -45,5 +45,5 @@
4545
'Programming Language :: Python :: 3.11',
4646
'Programming Language :: Python :: 3.12',
4747
],
48-
entry_points={'console_scripts': ['changelogs=changelogs.src:main']},
48+
entry_points={'console_scripts': ['changelog=changelog.src:main']},
4949
)

0 commit comments

Comments
 (0)