update docs

nickp60 · Apr 22, 2024 · 0f50da8 · 0f50da8
1 parent 6f8e53f
commit 0f50da8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -32,9 +32,20 @@ pip install --editable .
 
 
 ## Usage (package)
-
+```python
+>>> from fcid import run
+>>> run.get_tech_type("CABBCANXX", run.FCIDs)
+[['HiSeq 2500'], 'High Output v3 flow cell']
+```
 
 ## Test
 ```
 pytest
 ```
+
+## Deployment
+
+1. Update version pyproject.toml
+2. commit and tag
+3. push to github and make a release
+4. check the package deployment action
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,11 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fcid"
-version = "0.0.6"
+version = "0.0.10"
 authors = [
  {name = "Nick Waters", email = "nickp60@gmail.com"},
 ]
-description = "Get Illumina Machine info from flowcell"
+description = "Get Illumina sequencer metadata from flowcell/machine identifier"
 readme = "README.md"
 requires-python = ">=3.7"
 license = {text = "MIT"}