update documentation and bump version number

UpstreamData · Jul 13, 2022 · ed17a0f · ed17a0f
1 parent 36fead3
commit ed17a0f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,8 +2,9 @@
 *A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Code style: black](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![Code style: black](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
 
 ## Intro
 Welcome to pyasic!  Pyasic uses an asynchronous method of communicating with asic miners on your network, which makes it super fast.

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,23 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.10.2"
+version = "0.11.0"
 description = "A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH."
 authors = ["UpstreamData <[email protected]>"]
+repository = "https://github.com/UpstreamData/pyasic"
+documentation = "https://pyasic.readthedocs.io/en/latest/"
+long_description = "
+# pyasic
+*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+
+You can install pyasic directly from pip with the command `pip install pyasic`
+
+[Documentation](https://pyasic.readthedocs.io/en/latest/)
+"
 
 [tool.poetry.dependencies]
 python = "^3.9"