From 203097114e5e7efe9062b0a049f9cdba3bc83417 Mon Sep 17 00:00:00 2001 From: fef Date: Mon, 30 Jan 2023 21:54:35 +0100 Subject: [PATCH] add readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..906baa5 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# http-cli + +`http` is the http command-line client you've been waiting for. +It's like `curl` except with a much more convenient interface. + +## Features + +- Automatically follows redirects by default +- Automatically pretty-prints JSON if stdout is a tty +- Automatically prepends `https://` to URLs without a protocol if called as `https` +- Written in pure Rust (!) + +## Installation + +Install Rust if for some reason you haven't already, then type `cargo build --release`. +Copy the newly created `target/release/http-util` to `/usr/local/bin` or some other +directory in your PATH, and rename it to `http`. +You may also want to create a link to this file called `https`; this utility will default +to HTTPS if called as such. +Lastly, you may want to copy `http.1` to `/usr/local/man/man1/` to get the manpage. + +Alternatively, you can also run `sudo make install` for the automated installation +procedure, although cargo might get a stroke if you run it as root. + +## License + +Copyright © 2023 anna <owt AT fef.moe>. + +This program is distributed under the 3-clause BSD license. +See the `LICENSE` file for details. +