Merge pull request #35 from optuna/fix-readme

Fix readme
optuna · May 22, 2024 · 881f885 · 881f885
2 parents 4c9315f + 02a1348
commit 881f885
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,8 @@
 OptunaHub Registry
 ==================
 
-__NOTICE: OptunaHub Registry is currently under preparation. We do not accept requests for package registration from the general public.__
+OptunaHub Registry is a registry service for sharing and discovering user-defined Optuna packages. It provides a platform for users to share their Optuna packages with others and discover useful packages created by other users.
+
+See the [OptunaHub Website](https://optuna.github.io/optunahub-web/) for registered packages.
+
+See also the [OptunaHub API documentation](https://optuna.github.io/optunahub/) for the API to use the registry, and the [OptunaHub tutorial](https://optuna.github.io/optunahub-registry/recipes/001_first.html) for how to register and discover packages.
diff --git a/pyproject.toml b/pyproject.toml
@@ -42,10 +42,10 @@ documentation = "https://optuna.github.io/optunahub-registry/"
 bugtracker = "https://github.com/optuna/optunahub-registry/issues"
 
 [tool.setuptools.packages.find]
-include = ["optunahub-registry*", "package*"]
+include = ["package*"]
 
 [tool.setuptools.dynamic]
-version = {attr = "optunahub-registry.version.__version__"}
+version = {attr = "version.__version__"}
 
 [tool.ruff]
 line-length = 99

diff --git a/optunahub-registry/version.py → version.py b/optunahub-registry/version.py → version.py