From fcdcebe3440cef912fc6c088883be672601ec7e7 Mon Sep 17 00:00:00 2001 From: Justin Wernick Date: Wed, 10 May 2023 20:37:07 +0200 Subject: Update docs to use crates.io instead of my git branch! --- readme.md | 70 +++++++++++++++++++++++++++++++------------------------------- readme.org | 2 +- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/readme.md b/readme.md index 469fb8d..0242a3f 100644 --- a/readme.md +++ b/readme.md @@ -1,23 +1,23 @@ # Table of Contents -1. [Getting Started](#org920ad93) - 1. [Usage](#orga0a1fa1) - 2. [Installation](#orgba2f24f) - 1. [Prerequisites](#orgcdc7511) - 2. [Building Shackle](#org028a898) - 3. [Creating the required directory structure](#org04bfc1c) - 4. [Set Shackle as your default shell](#org42a08f6) -2. [Operating System Support](#orgee1f10f) -3. [Development Guide](#org4ab94d8) - 1. [Development Environment Setup](#org37992c2) - 2. [Running Tests](#org435149f) - 3. [Linting](#orge2138f7) - 4. [Building a Release Binary](#org2987255) -4. [Roadmap / Issue Tracker TODO list](#orgd145959) - 1. [MVP](#org90cf3d0) - 2. [Post-MVP](#orge18567c) -5. [License](#org3e0d656) +1. [Getting Started](#org9c3903e) + 1. [Usage](#org6fa9d8a) + 2. [Installation](#org10b2c96) + 1. [Prerequisites](#orgd426ed1) + 2. [Building Shackle](#orgb7eee70) + 3. [Creating the required directory structure](#orgf8fd81a) + 4. [Set Shackle as your default shell](#org58e1057) +2. [Operating System Support](#org8418be0) +3. [Development Guide](#org8b93b3d) + 1. [Development Environment Setup](#org6250a5d) + 2. [Running Tests](#org7f14941) + 3. [Linting](#orgc006671) + 4. [Building a Release Binary](#orgcd5123a) +4. [Roadmap / Issue Tracker TODO list](#orgba8330a) + 1. [MVP](#org565bb14) + 2. [Post-MVP](#org50cfb78) +5. [License](#org013cf1e) A shell for restricting access on a version control server. @@ -37,12 +37,12 @@ differences: - (coming soon!) Support for other other version control systems. - + # Getting Started - + ## Usage @@ -101,12 +101,12 @@ all of the options, and is a great way to learn what all the commands do. -h, --help Print help - + ## Installation - + ### Prerequisites @@ -121,7 +121,7 @@ all of the options, and is a great way to learn what all the commands do. the OpenSSH daemon. - + ### Building Shackle @@ -134,10 +134,10 @@ build from source. # This installs to Cargo's default, which is ~/.cargo/bin. Consider using the # --root option to install it somewhere that makes more sense for your server. - cargo install --git https://code.worthe-it.co.za/shackle.git/ --force + cargo install shackle-shell - + ### Creating the required directory structure @@ -160,7 +160,7 @@ users have a `~/git` symlink in their home directory which actually points at chmod --recursive u=rwX,g=rwXs,o= ~/git/$GROUP - + ### Set Shackle as your default shell @@ -171,7 +171,7 @@ will be Shackle. sudo usermod --shell $HOME/.cargo/bin/shackle-shell $USER - + # Operating System Support @@ -182,12 +182,12 @@ currently tested, and there are currently no plans to do so. I would not expect it to work on Windows. - + # Development Guide - + ## Development Environment Setup @@ -231,7 +231,7 @@ environment ready. # Note: you need to log out and in again for the new group to take effect - + ## Running Tests @@ -240,7 +240,7 @@ All unit tests are run with Cargo. cargo test - + ## Linting @@ -253,7 +253,7 @@ And it can be run via Cargo. cargo clippy - + ## Building a Release Binary @@ -264,12 +264,12 @@ Release binaries should be built in release mode. After running this, the binary is available in `./target/release/shackle-shell` - + # Roadmap / Issue Tracker TODO list - + ## MVP @@ -303,7 +303,7 @@ After running this, the binary is available in `./target/release/shackle-shell` - [X] help docs on all the commands - + ## Post-MVP @@ -324,7 +324,7 @@ After running this, the binary is available in `./target/release/shackle-shell` - [ ] pijul support on other commands - + # License diff --git a/readme.org b/readme.org index df47bfe..41e936a 100644 --- a/readme.org +++ b/readme.org @@ -112,7 +112,7 @@ build from source. #+begin_src sh # This installs to Cargo's default, which is ~/.cargo/bin. Consider using the # --root option to install it somewhere that makes more sense for your server. - cargo install --git https://code.worthe-it.co.za/shackle.git/ --force + cargo install shackle-shell #+end_src *** Creating the required directory structure -- cgit v1.2.3