From 21230c9c753b4034f8d020edb2846b40bd77f724 Mon Sep 17 00:00:00 2001 From: Ikuya Yamada Date: Fri, 12 Jan 2024 18:07:43 +0900 Subject: [PATCH] update docs --- CONTRIBUTING.md | 6 +++--- README.rst | 13 ++++++++++--- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdae474..15ec91b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ ### Build and publish package -1. Change `version` argument in `setup.py:setup` -2. Git tag and push it to Github repository. (e.g. `git tag 0.1.0 && git push origin 0.1.0`) +1. Change `version` argument in `setup.cfg` +2. Git tag and push it to Github repository. (e.g. `git tag v0.1.0 && git push origin v0.1.0`) 3. mojimoji is automatically built and published to pypi by github actions -See .github/workflows/*yml for the configuration of CI. +See .github/workflows/\*.yml for the configuration of CI. diff --git a/README.rst b/README.rst index 3cd4fac..4ce50c0 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,17 @@ mojimoji ======== -.. image:: https://badge.fury.io/py/mojimoji.png - :target: http://badge.fury.io/py/mojimoji +.. image:: https://github.com/studio-ousia/mojimoji/actions/workflows/test.yml/badge.svg + :target: https://github.com/studio-ousia/mojimoji/actions/workflows/test.yml -A fast converter between Japanese hankaku and zenkaku characters. +.. image:: https://img.shields.io/pypi/v/mojimoji.svg?style=flat-square&logo=pypi&logoColor=white + :target: https://pypi.org/project/mojimoji/ + +.. image:: https://static.pepy.tech/personalized-badge/mojimoji?period=total&units=international_system&left_color=grey&right_color=orange&left_text=pip%20downloads + :target: https://pypi.org/project/mojimoji/ + + +A Cython-based fast converter between Japanese hankaku and zenkaku characters. Installation ------------