Add basic documentation

README.md

@@ -0,0 +1,23 @@
+# What is this?
+
+Mynerva is a platform for creating, distributing, and hosting experiential
+educational content. See the [Mynerva website](https://mynerva.io/) for more
+information about Mynerva.
+
+The authoring platform is currently available via invitation. If you're
+interesting in authoring on Mynerva, please
+[request an invitation](https://forms.office.com/Pages/ResponsePage.aspx?id=cFbouBAmSk2vcnxt3VMlwbJg85jcPCpCrF0eBHnGiARURE1NSU5MVE85QTNZQklLRlY4MThQOFRTTC4u)
+(we're friendly, we promise!).
+
+# Installation
+
+See the [Installation documentation](./docs/install.md) for instructions on how
+to install the `mynerva-author` command line tool.
+
+# Usage
+
+The `mynerva-author` command line tool is under active development and may
+change rapidly. For usage instructions, including a quick-start guide and MyST
+syntax reference, please see the
+[Authoring on Mynerva](https://www.notion.so/Authoring-on-Mynerva-e4bae239b894423cb87e63c5a16673b7)
+documentation.

docs/install.md

@@ -0,0 +1,101 @@
+# Install `mynerva-author`
+
+## Install the command line tool
+
+Follow the instructions below for your operating system to install the
+`mynerva-author` command line tool. Be sure to follow the
+[Verify your installation](#verify-your-installation) steps after following the
+OS-specific instructions.
+
+### macOS
+
+Use [Homebrew](https://brew.sh/).
+
+1.  [Install Homebrew](https://brew.sh/) (if not already installed).
+2.  Install the command line tool.
+    ```shell
+    brew install mynerva-io/tap/mynerva-author
+    ```
+
+### Windows
+
+1.  [Install Scoop](https://scoop.sh/) (if not already installed). From
+    PowerShell (**not** _Command Prompt_), run these commands to install Scoop.
+
+    ```powershell
+    # Allow PowerShell to execute arbitrary code (you may be prompted to allow this)
+    Set-ExecutionPolicy RemoteSigned -scope CurrentUser
+
+    # Download and execute the Scoop installer
+    Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://get.scoop.sh')
+    ```
+
+2.  Install the command line tool.
+
+    ```powershell
+    # Install git (this is required to add the Mynerva bucket)
+    scoop install git
+
+    # Tell scoop where to find Mynerva's published packages
+    scoop bucket add mynerva https://github.com/mynerva-io/scoop-bucket.git
+
+    # Install the mynerva-author tool
+    scoop install mynerva/mynerva-author
+    ```
+
+### Custom installation
+
+If you're using Linux, or you want more control over your installation, you can
+follow these steps.
+
+1.  Download the binary from the
+    [latest GitHub release](https://github.com/mynerva-io/author-cli/releases).
+2.  Add the executable to your `PATH`. Make sure to set the executable bit if
+    necessary.
+
+Alternatively, you can download and build the Go source code.
+
+## Verify your installation
+
+1.  Log in to Mynerva using the command line tool.
+    ```shell
+    # Authenticate with the Mynerva API
+    # This should prompt you for your email and password
+    mynerva-author auth login
+    ```
+2.  Verify that the authentication worked.
+    ```shell
+    mynerva-author auth status
+    ```
+    The output should look something like this:
+    ```
+    ✅ Authenticated (until Tue, 06 Apr 2021 00:38:46 UTC)
+    ```
+
+# Upgrade
+
+The `mynerva-author` command line is periodically updated. It may be necessary
+to update your installed version in order to deal with breaking changes in the
+Mynerva API or to access newer features.
+
+## Upgrade on macOS (Homebrew)
+
+Open a terminal and run this command.
+
+```shell
+brew upgrade mynerva-author
+```
+
+## Upgrade on Windows (Scoop)
+
+Open PowerShell and run this command.
+
+```powershell
+scoop update mynerva-author
+```
+
+## Upgrade custom installation
+
+Download a new binary as described in the
+[Custom installation](#custom-installation) and replace the old binary with the
+new binary.