chore: version bump and readme updates
d624f56e
2 file(s) · +25 −16
| 1 | 1 | [package] |
|
| 2 | 2 | name = "sipp-so" |
|
| 3 | - | version = "0.1.4" |
|
| 3 | + | version = "0.1.5" |
|
| 4 | 4 | edition = "2024" |
|
| 5 | 5 | description = "Minimal code sharing - single binary for web server, CLI, and TUI" |
|
| 6 | 6 | license = "MIT" |
| 12 | 12 | - Interactive TUI with authenticated access for snippet management |
|
| 13 | 13 | - Minimal, fast, and low memory consumption |
|
| 14 | 14 | ||
| 15 | - | ## Demo |
|
| 16 | - | ||
| 17 | - | Try it out at [sipp.so](https://sipp.so) or install and use the TUI |
|
| 18 | - | ||
| 19 | - | ```bash |
|
| 20 | - | sipp -r https://sipp.so |
|
| 21 | - | ``` |
|
| 22 | - | ||
| 23 | 15 | ## Quickstart |
|
| 24 | 16 | ||
| 25 | - | **1. Installo** |
|
| 17 | + | **1. Install** |
|
| 26 | 18 | ||
| 27 | - | Install the binary from Crates.io |
|
| 19 | + | Install via the [releases](https://github.com/stevedylandev/sipp/releases) page, or directly with `cargo` |
|
| 28 | 20 | ||
| 29 | 21 | ```bash |
|
| 30 | 22 | cargo install sipp-so |
|
| 56 | 48 | sipp |
|
| 57 | 49 | ``` |
|
| 58 | 50 | ||
| 51 | + | ## Demo Instance |
|
| 52 | + | ||
| 53 | + | A small instance running at [sipp.so](https://sipp.so) that can be used for testing and demo purposes. |
|
| 54 | + | ||
| 55 | + | ```bash |
|
| 56 | + | sipp -r https://sipp.so |
|
| 57 | + | ``` |
|
| 58 | + | ||
| 59 | + | >[!WARNING] |
|
| 60 | + | >All snippets created here are public and might be deleted at any time; host your own instance with your own API key for personal use! |
|
| 61 | + | ||
| 59 | 62 | ## Install |
|
| 60 | 63 | ||
| 61 | 64 | Sipp can be installed several ways |
|
| 62 | 65 | ||
| 66 | + | ### Releases |
|
| 67 | + | ||
| 68 | + | Visit the [releases](https://github.com/stevedylandev/sipp/releases) page and install through cURL script and other methods. |
|
| 69 | + | ||
| 70 | + | ### Homebrew |
|
| 71 | + | ||
| 72 | + | ``` |
|
| 73 | + | brew install stevedylandev/tap/sipp-so |
|
| 74 | + | ``` |
|
| 75 | + | ||
| 63 | 76 | ### Cargo |
|
| 64 | - | Install with Cargo directly |
|
| 65 | 77 | ||
| 66 | 78 | ```bash |
|
| 67 | 79 | cargo install sipp-so |
|
| 68 | 80 | ``` |
|
| 69 | - | ||
| 70 | - | ### GitHub Releases |
|
| 71 | - | Visit the [releases](https://github.com/stevedylandev/sipp/releases) page and download one of the prebuilt binaries |
|
| 72 | 81 | ||
| 73 | 82 | ## Usage |
|
| 74 | 83 | ||
| 229 | 238 | ||
| 230 | 239 | ### Railway |
|
| 231 | 240 | ||
| 232 | - | 1. Connect your repository to [Railway](https://railway.app) |
|
| 241 | + | 1. Fork this repo and connect your fork to [Railway](https://railway.app) |
|
| 233 | 242 | 2. Set the environment variables `SIPP_API_KEY` and optionally `SIPP_AUTH_ENDPOINTS` |
|
| 234 | 243 | 3. Add a [volume](https://docs.railway.com/guides/volumes) to your service and mount it at `/data` |
|
| 235 | 244 | 4. Set `SIPP_DB_PATH` to `/data/sipp.sqlite` so the database persists across deploys |
|