Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/unify readme #186

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Feature/unify readme #186

wants to merge 19 commits into from

Commits on May 28, 2020

  1. chg: dev: rename to rst

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    194110d View commit details
    Browse the repository at this point in the history

  2. new: doc: text from setup.py

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    3263efd View commit details
    Browse the repository at this point in the history

  3. chg: dev: format based on rst

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    6a16ba1 View commit details
    Browse the repository at this point in the history

  4. chg: dev: use readme for long description

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    9b76da4 View commit details
    Browse the repository at this point in the history

  5. chg: dev: include readme in manifest

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    0fd741b View commit details
    Browse the repository at this point in the history

  6. new: dev: travis badge

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    70748cf View commit details
    Browse the repository at this point in the history

  7. new: doc: pypi badge

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    9bf2eed View commit details
    Browse the repository at this point in the history

  8. chg: dev: use codecs for python 2 compatibility

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    b9e0565 View commit details
    Browse the repository at this point in the history

  9. chg: dev: add suggestion

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    8f9bac0 View commit details
    Browse the repository at this point in the history

  10. chg: dev: projects urls

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    fb38859 View commit details
    Browse the repository at this point in the history

  11. chg: doc: use global-option for pip 20.0

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    57be2a0 View commit details
    Browse the repository at this point in the history

  12. chg: doc: for pip < 20.0

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    e5a27a4 View commit details
    Browse the repository at this point in the history

  13. new: doc: source code url

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    a68000c View commit details
    Browse the repository at this point in the history

  14. chg: doc: installation 

    - use `python -m pip`
- use global-option only
    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    e841551 View commit details
    Browse the repository at this point in the history

  15. chg: doc: use https

    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    596ca50 View commit details
    Browse the repository at this point in the history

  16. chg: doc: use https on readme 

    based on yaml#223
    @rachmadaniHaryono
    rachmadaniHaryono committed May 28, 2020
    Configuration menu
    Copy the full SHA
    897dc25 View commit details
    Browse the repository at this point in the history

Commits on Nov 23, 2021

  1. Merge remote-tracking branch 'upstream/master' into feature/unify-readme

    @rachmadaniHaryono
    rachmadaniHaryono committed Nov 23, 2021
    Configuration menu
    Copy the full SHA
    dd26747 View commit details
    Browse the repository at this point in the history

  2. chg: doc: update to latest readme 

    this will remove the README.rst and move the content to README.md

this include

- badge
- recommended installation method
- recommended way for alternative method
- fix link to document on above point
- code markup

it also point to README.md for LONG_DESCRIPTION

Signed-off-by: Rachmadani Haryono <foreturiga@gmail.com>
    @rachmadaniHaryono
    rachmadaniHaryono committed Nov 23, 2021
    Configuration menu
    Copy the full SHA
    9e446ae View commit details
    Browse the repository at this point in the history

  3. chg: doc: long_description_content_type 

    based on
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#including-your-readme-in-your-package-s-metadata

Signed-off-by: Rachmadani Haryono <foreturiga@gmail.com>
    @rachmadaniHaryono
    rachmadaniHaryono committed Nov 23, 2021
    Configuration menu
    Copy the full SHA
    c77af38 View commit details
    Browse the repository at this point in the history