chore: update docs ci name and readme

tlambert03 · Jun 25, 2023 · effb3e1 · effb3e1
1 parent e5418fc
commit effb3e1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,4 +1,5 @@
-name: ci
+name: docs
+
 on:
   push:
     branches:

diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ compatibility and data extraction. (If you find an nd2 file that fails in some
 way, please [open an issue](https://github.com/tlambert03/nd2/issues/new) with
 the file!)
 
+### :book: [Documentation](https://tlambert03.github.io/nd2)
+
 ## install
 
 ```sh
@@ -56,7 +58,12 @@ than the built-in `xml` module.  To install with support for `lxml` use:
 pip install nd2 lxml
 ```
 
-## usage and API
+## Usage and API
+
+Full API documentation is available at
+[https://tlambert03.github.io/nd2](https://tlambert03.github.io/nd2)
+
+Quick summary below:
 
 ```python
 import nd2