docs: improved readme and sidebar layout

Sidebar also includes links to repo and license
cryoem-uoft · Dec 12, 2022 · 5a335b6 · 5a335b6 · vercel · Dec 12, 2022
1 parent 6097e50
commit 5a335b6
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # cryosparc-tools
 
+[![PyPI](https://badgen.net/pypi/v/cryosparc-tools)](https://pypi.org/project/cryosparc-tools/)
+[![Python package](https://github.com/cryoem-uoft/cryosparc-tools/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/cryoem-uoft/cryosparc-tools/actions/workflows/python-package.yml)
+
 Toolkit for interfacing with CryoSPARC. Read the documentation at
 [tools.cryosparc.com](https://tools.cryosparc.com)
 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -32,4 +32,11 @@ parts:
     - file: api/mrc
     - file: api/star
     - file: api/command
-  - file: CHANGELOG
+- caption: Links
+  chapters:
+  - url: https://github.com/cryoem-uoft/cryosparc-tools
+    title: GitHub Repository
+  - url: https://github.com/cryoem-uoft/cryosparc-tools/blob/main/CHANGELOG.md
+    title: Changelog
+  - url: https://github.com/cryoem-uoft/cryosparc-tools/blob/main/LICENSE
+    title: License
diff --git a/docs/intro.md b/docs/intro.md
@@ -15,6 +15,8 @@ Use it for the following use cases:
 This guide documents usage of the `cryosparc-tools` Python library. For CryoSPARC installation or general CryoSPARC usage instructions, [read the official guide](https://guide.cryosparc.com).
 ```
 
+Source code is [available on GitHub](https://github.com/cryoem-uoft/cryosparc-tools).
+
 ## Pre-requisites
 
 - [Python ≥ 3.7, ≤ 3.10](https://www.python.org/downloads/) (3.11 support is experimental)