From 8623ad4ebd93a5288c210f3e7bad64f09d23d2cd Mon Sep 17 00:00:00 2001
From: Matt Johnston <matt@ucc.asn.au>
Date: Fri, 23 Sep 2022 00:05:24 +0800
Subject: [PATCH] Add README, gitignore lines, Cargo details

---
 .gitignore | 5 ++++-
 Cargo.toml | 2 ++
 README.md  | 7 +++++++
 3 files changed, 13 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index e2a3069..32a6d9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,5 @@
 /target
-*~
+**~
+*.swp
+*.sublime-*
+*.pub
diff --git a/Cargo.toml b/Cargo.toml
index 83f80eb..20faf38 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,6 +2,8 @@
 name = "sunset"
 version = "0.1.0"
 edition = "2021"
+description = "A SSH library suitable for embedded and larger programs"
+repository = "https://github.com/mkj/sunset"
 categories = ["network-programming", "no-std"]
 keywords = ["ssh"]
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48d3d3c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Sunset SSH
+
+This is a SSH client and server implementation. It is designed to be usable in
+`no_std` embedded environments. The [`sunset-async`](async/) crate lets it be
+used in other non-embedded software.
+
+** This software is incomplete and not ready to be used **
-- 
GitLab