Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ikuyamada committed Jan 12, 2024
1 parent 89b6032 commit 21230c9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
------------
Expand Down

0 comments on commit 21230c9

Please sign in to comment.