doc: Point users to prr book

README.md

@@ -15,198 +15,4 @@ The tool was born of frustration from using the point-and-click editor text
 boxes on PRs. I happen to do a lot of code review and tabbing to and from the
 browser to cross reference code from the changes was driving me nuts.
 
-For a higher level walkthrough of `prr`, please see my blog posts: [Pull
-request review (prr)][1] and [Pull request review: still files!][2]
-
-## Contents:
-
-- [Installation / Quickstart](#installation--quickstart)
-- [Feature reference](#features)
-- [Vim integration](#vim-integration)
-- [Config reference](#config)
-
-## Installation / Quickstart
-
-1. Install `prr`:
-
-    - **Option 1:** Install rust toolchain (if you haven't already): https://rustup.rs/
-
-        ```sh
-        $ cargo install prr
-        ```
-
-    - **Option 2:** [Homebrew](https://brew.sh/)
-
-        ```sh
-        $ brew install prr
-        ```
-
-2. Create a Github Personal Access Token (PAT) for `prr`:
-
-    `prr` will need this token so it can make GH API calls on your behalf.
-    Create the token by going to `Settings -> Developer settings -> Personal
-    access tokens -> Generate new token` and give the token `repo` permissions.
-
-    Keep the newly generated token handy for the next step.
-
-3. Create a `prr` config file:
-
-    ```sh
-    $ mkdir -p ~/.config/prr
-
-    $ cat << EOF > ~/.config/prr/config.toml
-    [prr]
-    token = "$YOUR_PAT_FROM_LAST_STEP"
-    workdir = "/home/dxu/dev/review"
-    EOF
-    ```
-
-    where `$YOUR_PAT_FROM_LAST_STEP` is the PAT token from step 3 and `workdir`
-    is the directory you want `prr` to place all your review files.
-
-4. Review your first PR:
-
-    Feel free to test `prr` out against my test repository, by the way.
-
-    ```sh
-    $ prr get danobi/prr-test-repo/6
-    /home/dxu/dev/review/danobi/prr-test-repo/6.prr
-
-    $ vim /home/dxu/dev/review/danobi/prr-test-repo/6.prr
-
-    $ prr submit danobi/prr-test-repo/6
-    ```
-
-    For details on how to actually mark up the review file, see the next
-    section titled "Features"
-
-## Features
-
-#### Review comment
-
-Description: PR-level review comment. You only get one of these per review.
-
-Syntax: Non-whitespace, non-quoted text at the beginning of the review file.
-
-[Example](examples/review_comment.prr)
-
-#### File comment
-
-Description: File-level comment.
-
-Syntax: Non-whitespace, non-quoted text immediately following the `diff --git` header
-
-[Example](examples/file_comment.prr)
-
-#### Inline comment
-
-Description: Inline comment attached to a specific line of the diff.
-
-Syntax: None-whitespace, non-quoted text on a newline immediately following
-a quoted non-header part of the diff.
-
-[Example](examples/inline_comment.prr)
-
-#### Spanned inline comment
-
-Description: Like an inline comment, except it covers a span of lines.
-
-Syntax: To start a span, insert one or more newlines immediately before
-a quoted, non-header part of the diff. To terminate a span, insert a
-inline comment.
-
-[Example](examples/spanned_inline_comment.prr)
-
-#### Snips
-
-Description: Use `[...]` to replace (ie. snip) contiguous quoted lines.
-
-Syntax: `[...]` or `[..]` on its own line. Multiple snips may be used in a review file.
-
-[Example](examples/snip.prr)
-
-#### Review directives
-
-Description: Meta-directives to give to `prr` in review comment. Currently
-only supports approving, requesting changes to, and commenting on a PR.
-
-Syntax: `@prr approve`, `@prr reject`, or `@prr comment`.
-
-[Example](examples/prr_directive.prr)
-
-## Vim integration
-
-`vim/` directory contains Vim plugin providing syntax coloring, filetype
-detection and folding configuration for `*.prr` files.
-
-To install it modify `&runtimepath` to add this directory or use plugin manager
-of your choice to add this plugin.
-
-#### Vundle installation
-
-```
-Plugin 'danobi/prr', {'rtp': 'vim/'}
-```
-
-#### Manual installation
-
-Copy the provided `*.vim` files into their appropriate subdirectories in
-`~/.vim`.
-
-#### Syntax colors
-
-The `prr` "plugin" exports some preconfigured syntax hooks. Here's [an example][0]
-of how to customize the individual colors.
-
-#### Folding
-
-With default Vim configuration all folds will be closed by default, so if you
-want them to be opened then you need to do one of these:
-
-- Add `set foldlevel=9999` in your Vim config to open all folds by default
-- Add `set nofoldenable` to disable folding
-
-Consult `:h folding` for more details.
-
-## Config
-
-`prr` supports various configuration options spread over one or more config
-files. The global config file must be located at `$XDG_CONFIG_HOME/prr/config.toml`.
-This typically expands to `$HOME/.config/prr/config.toml`.
-
-`prr` also supports local config files. Local config files must be named
-`.prr.toml` and will be searched for starting from the current working
-directory up every parent directory until either the first match or the root
-directory is hit. Local config files override values in the global config.
-Table specific semantics are documented below.
-
-#### [prr]
-
-The `[prr]` table controls installation wide settings.
-
-* `prr.token`: Personal authentication token (required)
-* `prr.workdir`: Directory to place review files (optional)
-* `prr.url`: URL to github API (optional)
-
-If this table is specified in a local config file, it must be fully specified
-and will override the global config file.
-
-#### [local]
-
-The `[local]` table contains configuration local to a directory and its
-sub-directories.
-
-* `local.repository`: A string in format of `${ORG}/${REPO}` (optional)
-    * If specified, you may omit the `${ORG}/${REPO}` from PR string arguments.
-      For example, you may run `prr get 6` instead of `prr get danobi/prr/6`.
-* `local.workdir`: Local workdir override (optional)
-    * See `prr.workdir`
-    * Relative paths are interpreted as relative to the local config file
-
-This table may not be specified in both a local config file and the global
-config file.
-
-
-[0]: https://github.com/danobi/dotfiles/blob/ab00f235fffd4c8d5e2496657e8047e1473d9257/vim/.vimrc#L81-L94
-[1]: https://dxuuu.xyz/prr.html
-[2]: https://dxuuu.xyz/prr2.html
+For full documentation, please visit https://doc.dxuuu.xyz/prr/.