From 969a020128e5804603362329363a7a05c0722769 Mon Sep 17 00:00:00 2001
From: Sam Tay <sam.chong.tay@gmail.com>
Date: Thu, 25 Jun 2020 19:28:12 -0700
Subject: Add katys logo

---
 README.md       |  35 ++++++++++++++++++++++++++++++-----
 assets/logo.png | Bin 0 -> 22442 bytes
 2 files changed, 30 insertions(+), 5 deletions(-)
 create mode 100644 assets/logo.png

diff --git a/README.md b/README.md
index 16a6b5c..eada46e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,21 @@
-[![Build Status (travis)](https://travis-ci.org/samtay/so.svg?branch=master)](https://travis-ci.org/samtay/so)
-[![Build status](https://ci.appveyor.com/api/projects/status/pu7e63f2sqq6x1iq/branch/master?svg=true)](https://ci.appveyor.com/project/samtay/so/branch/master)
+<h1 align="center">
+<img width="300px" src="assets/logo.png" />
+
+[![travis][s0]][l0] [![appveyor][s1]][l1] [![crates][s2]][l2] ![MIT][s3]
+
+</h1>
+
+[s0]: https://travis-ci.org/samtay/so.svg?branch=master
+[l0]: https://travis-ci.org/samtay/so
+[s1]: https://ci.appveyor.com/api/projects/status/pu7e63f2sqq6x1iq/branch/master?svg=true
+[l1]: https://ci.appveyor.com/project/samtay/so/branch/master
+[s2]: https://img.shields.io/crates/v/so.svg
+[l2]: https://crates.io/crates/so
+[s3]: https://img.shields.io/badge/license-MIT-blue.svg
+
+<h5 align="center">A terminal interface for StackOverflow written in Rust</h5>
 
 # so
-A terminal interface for StackOverflow.
 
 **Note**: still working out some kinks. Initial release not published just yet.
 **<Insert GIF here>**
@@ -30,10 +43,19 @@ $ so -e google -s askubuntu -s stackoverflow -s unix how do i install linux
 The quickest installation method is to download the appropriate
 binary from the [release artifacts](https://github.com/samtay/so/releases).
 You can quickly
-install the binary for common targets (Linux, MacOS, Windows) with:
+install the binary for common targets (Linux, MacOS, Windows) to directory
+`DEST` with:
 ```shell
-curl --proto '=https' --tlsv1.2 -sSf https://samtay.github.io/so/install.sh | bash -s -- --to /usr/local/bin
+curl --proto '=https' --tlsv1.2 -sSf https://samtay.github.io/so/install.sh | bash -s -- --to DEST
 ```
+Note: you may need extra permissions for certain paths, e.g.
+```shell
+# install to /usr/local/bin
+curl --proto '=https' --tlsv1.2 -sSf https://samtay.github.io/so/install.sh | sudo bash -s -- --to /usr/local/bin.
+```
+And of course, you may want to `curl https://samtay.github.io/so/install.sh`
+first and make sure you're comfortable executing it. You can also view it
+[here](./docs/install.sh).
 
 Right now I'm only building the most common targets, but in theory it should be
 easy to add more, so if you don't see what you are looking for just open an
@@ -48,6 +70,9 @@ and open an issue with the output of `rustc -Vv | grep host | cut -d' ' -f2`.
 cargo install so
 ```
 
+### os packages
+Coming soon. Help appreciated!
+
 ## documentation
 The configuration files for e.g. a user `Alice` can be found in the following
 directories:
diff --git a/assets/logo.png b/assets/logo.png
new file mode 100644
index 0000000..1804302
Binary files /dev/null and b/assets/logo.png differ
-- 
cgit v1.2.3