From 93cacaa5c1cec328c510fd5a0605fcdca0365864 Mon Sep 17 00:00:00 2001 From: ListLee Date: Thu, 18 Apr 2024 02:02:35 +0800 Subject: [PATCH] update readme --- README.md | 22 ++++++++++++++-------- pyproject.toml | 8 +++++++- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8a86705..ea5ff53 100644 --- a/README.md +++ b/README.md @@ -8,28 +8,34 @@ Notice: This package is the brand new version of the old `Pearson3CurveFitting` package. For the old version, please refer to the [archived repository](https://github.com/tanukihee/Pearson3CurveFittingArchive). +## Installation + +```bash +pip install pearson3curve +``` + +## Usages + +See [API Documentation](https://github.com/tanukihee/pearson3curve/blob/main/docs/api.md) for details. + ## Examples ### Successive Data -See [Successive Data Example](./example/successive.py) for the code. +See [Successive Data Example](https://github.com/tanukihee/pearson3curve/blob/main/example/successive.py) for the code. Figure example: -successive +successive ### Non-Successive Data -See [Non-Successive Data Example](./example/nonsuccessive.py) for the code. +See [Non-Successive Data Example](https://github.com/tanukihee/pearson3curve/blob/main/example/nonsuccessive.py) for the code. Figure example in Chinese, using pgf backend for better multi-language text and math typesetting support: -nonsuccessive - -## Usages - -See [API Documentation](./docs/api.md) for details. +nonsuccessive ## Development diff --git a/pyproject.toml b/pyproject.toml index 3e3f1b1..e870d7c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "pearson3curve" -version = "1.0.0" +version = "1.0.0r" description = "Pearson III curve fitting and plotting" authors = [{ name = "ListLee", email = "list.lee@outlook.com" }] dependencies = [ @@ -13,6 +13,12 @@ requires-python = ">=3.9" readme = "README.md" license = { text = "MIT" } +[project.urls] +Homepage = "https://github.com/tanukihee/pearson3curve" +Documentation = "https://github.com/tanukihee/pearson3curve/blob/main/docs/api.md" +Repository = "https://github.com/tanukihee/pearson3curve.git" +Issues = "https://github.com/tanukihee/pearson3curve/issues" + [build-system] requires = ["pdm-backend"] build-backend = "pdm.backend"