From 9098137be18ba1306548288dfdde35af72271d0f Mon Sep 17 00:00:00 2001 From: Chloe Kudryavtsev Date: Tue, 26 Nov 2019 15:23:09 -0500 Subject: Update README because CI is a thing now --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 1154f52..e781d9c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,26 @@ Burning Rubber Paste ==================== +[![Build Status](https://cloud.drone.io/api/badges/5paceToast/brpaste/status.svg)](https://cloud.drone.io/5paceToast/brpaste) + `brpaste` is a small and fast pastebin service. It provides a lightweight REST-like interface and client-side syntax highlighting (if desired). It's small and fast because it relies on redis to perform the actual storage. +### Quickstart +#### Go edition +`go get -u toast.cafe/x/brpaste` +#### Github edition +Download the correct binary from the releases page. +#### CI (nightly master) edition +Download your build from https://minio.toast.cafe/cicd/brpaste/brpaste-$OS-$ARCH where `$OS` is something like "openbsd" and `$ARCH` is something like "amd64". +Note that the github edition binaries are just these from immediately after a release. + +### Platform Support +Linux AMD64 is the primary platform. +Everything else is "best effort". +For a full list of supported platforms, see the releases page (all the binaries on there). + ### Speed It's just fast. I could put a bunch of benchmarks here but people didn't really seem to care in the previous version anyway. -- cgit v1.2.3