diff --git a/.gitignore b/.gitignore index e2a3069b6ee98740d149140b881d6947483653c9..32a6d9e00d70732a8ed231386ab9c775834535db 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ /target -*~ +**~ +*.swp +*.sublime-* +*.pub diff --git a/Cargo.toml b/Cargo.toml index 83f80eb3e40a1dacf6d39fdec8ac34948e3aefa2..20faf384909f99e3ad0cf84c7a24b914c611e41e 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 0000000000000000000000000000000000000000..48d3d3cd9b827eb0d5320bfa6c4fdfc710933d4b --- /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 **