chore:add tutorials to README

README.md

@@ -20,3 +20,70 @@ so you do not need to enter the password again when you log in again.
         height="500">
 </p>
 
+## Getting Started
+
+## Installation
+
+Download binary from [releases](https://github.com/vimiix/ssx/releases), extract it and add its path to your `$PATH` list.
+
+### Add a new entry
+
+```bash
+ssx -s [USER@]HOST[:PORT] [-i IDENTIDY_FILE]
+```
+
+If given address matched an exist entry, ssx will login directly.
+
+### List exist entries
+
+```bash
+ssx list
+# output example
+# Entries (stored in ssx)
+#  ID |       Address        |          Tags
+#-----+----------------------+--------------------------
+#  1  | root@172.23.1.84:22  | centos
+```
+
+ssx does not read `~/.ssh/config` by default unless the environment variable `SSX_IMPORT_SSH_CONFIG` is set.
+ssx will not store user ssh config entries to itself db, so you won't see their `ID` in the output of the list command 
+
+```bash
+export SSX_IMPORT_SSH_CONFIG=true
+ssx list
+# output example
+# Entries (stored in ssx)
+#  ID |       Address        |          Tags
+#-----+----------------------+--------------------------
+#  1  | root@172.23.1.84:22  | centos
+#
+# Entries (found in ssh config)
+#               Address              |           Tags
+# -----------------------------------+----------------------------
+#   git@ssh.github.com:22            | github.com
+```
+
+### Tag an entry
+
+```bash
+ssx tag -i <ENTRY_ID> -t TAG1 [-t TAG2 ...]
+```
+Once we tag the entry, we can log in through the tag later.
+
+### Delete an entry
+
+```bash
+ssx delete -i <ENTRY_ID>
+```
+
+## Supported environment variables
+
+- `SSX_DB_PATH`: DB file to store entries, default is `~/.ssx.db`.
+- `SSX_CONNECT_TIMEOUT`: SSH connect timeout, default is `10s`.
+- `SSX_IMPORT_SSH_CONFIG`: Whether to import the user ssh config, default is empty.
+
+## Copyright
+
+© 2023 Qian Yao
+
+Distributed under the MIT License. See [LICENSE](https://github.com/vimiix/ssx/blob/main/LICENSE) file for details.