Prep for v1.0.0.

pimoroni · May 20, 2024 · 1f835c0 · 1f835c0
1 parent df65e3e
commit 1f835c0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+1.0.0
+-----
+
+* Repackage to hatch/pyproject.toml
+
 0.0.2
 -----
 

diff --git a/README.md b/README.md
@@ -5,15 +5,31 @@
 [![PyPi Package](https://img.shields.io/pypi/v/icm20948.svg)](https://pypi.python.org/pypi/icm20948)
 [![Python Versions](https://img.shields.io/pypi/pyversions/icm20948.svg)](https://pypi.python.org/pypi/icm20948)
 
+
 # Installing
 
-Stable library from PyPi:
+If you've already set up a Python virtual environment, you can also install the stable library manually from PyPi:
+
+```
+pip install icm20948
+```
+
+Otherwise our install script will set one up for you.
+
+Stable library from GitHub:
 
-* Just run `python3 -m pip install icm20948`
+```
+git clone https://github.com/pimoroni/icm20948-python
+cd icm20948-python
+./install.sh
+```
 
 Latest/development library from GitHub:
 
-* `git clone https://github.com/pimoroni/icm20948-python`
-* `cd icm20948-python`
-* `./install.sh --unstable`
+```
+git clone https://github.com/pimoroni/icm20948-python
+cd icm20948-python
+./install.sh --unstable
+```
 
+**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:
diff --git a/icm20948/__init__.py b/icm20948/__init__.py
@@ -1,7 +1,7 @@
 import struct
 import time
 
-__version__ = '0.0.2'
+__version__ = '1.0.0'
 
 CHIP_ID = 0xEA
 I2C_ADDR = 0x68