feat: update README

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Build and test cy
+name: CI
 
 on:
   push:

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Deploy
+name: Deploy documentation
 on:
   push:
     branches:
@@ -22,13 +22,13 @@ jobs:
           mkdir mdbook
           curl -sSL $url | tar -xz --directory=./mdbook
           echo `pwd`/mdbook >> $GITHUB_PATH
-      - name: Build Book
+      - name: Build book
         run: |
           cd docs
           mdbook build
-      - name: Setup Pages
+      - name: Setup pages
         uses: actions/configure-pages@v2
-      - name: Upload artifact
+      - name: Upload site
         uses: actions/upload-pages-artifact@v1
         with:
           # Upload entire repository

README.md

@@ -9,6 +9,9 @@
 </p>
 
 <p align="center">
+    <a target="_blank" href="https://github.com/cfoust/cy/actions/workflows/ci.yml">
+        <img src="ttps://github.com/cfoust/cy/actions/workflows/ci.yml/badge.svg" />
+    </a>
     <img src="https://img.shields.io/badge/Go-00ADD8?logo=go&logoColor=white" alt="Go Language" />
     <!-- LICENSE -->
     <a target="_blank" href="https://github.com/cfoust/cy/blob/main/LICENSE">
@@ -18,22 +21,9 @@
 
 ## What is this?
 
-`cy` is an experimental terminal multiplexer that aims to be a simple, modern, and ergonomic alternative to `tmux`.
-
-I have used `tmux` for nearly a decade and while it is a powerful tool, it has its fair share of inadequacies. I built a plugin, [tmux-oakthree](https://github.com/cfoust/tmux-oakthree) that simplifies tmux to match my workflow exactly, but over time I found that I still wanted more.
+`cy` is an experimental terminal multiplexer that aims to be a simple, modern, and ergonomic alternative to `tmux`. You can find out more in **[the documentation](https://cfoust.github.io/cy/)**.
 
 The `cy` project has a few main goals:
 * Be beautiful, fast, and easy-to-use, particularly for users who have not used `tmux` or who are intimidated by its default configuration.
 * Allow users to search in and replay any `cy` session.
 * Stay simple. `cy` is specifically _not_ a clone of `tmux` and will never have all of its functionality (panes, etc).
-
-## Roadmap
-
-* [ ] **Usability**
-* [ ] **Development**
-    * [ ] Implement [oakthree](https://github.com/cfoust/tmux-oakthree)
-        * [ ] Store pane jump history
-    * [ ] Logging API in Janet
-        * [ ] Support unmarshaling Janet table to `map[string]interface{}`
-* [ ] **Replay**
-    * [ ] Don't record bytes matching regex (IPs etc)

docs/book.toml

@@ -4,3 +4,7 @@ language = "en"
 multilingual = false
 src = "src"
 title = "cy documentation"
+
+[output.html]
+default-theme = "ayu"
+preferred-dark-theme = "ayu"