From 2f3bea459ccdf23c8797d7753c8247475bf9e280 Mon Sep 17 00:00:00 2001
From: Kristofers Solo <dev@kristofers.xyz>
Date: Wed, 15 Jan 2025 16:23:59 +0200
Subject: [PATCH] docs: add README.md

---
 Cargo.toml | 10 ++++++++++
 README.md  | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/Cargo.toml b/Cargo.toml
index 0b6deeb..5db67dd 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,7 +1,17 @@
 [package]
 name = "sula-alus"
+authors = ["Kristofers Solo <dev@kristofers.xyz>"]
 version = "0.1.0"
 edition = "2021"
+description = "A CLI tool to encode strings and files using Sula-Alus encoding"
+repository = "https://github.com/kristoferssolo/sula-alus"
+documentation = "https://docs.rs/sula-alus"
+homepage = "https://github.com/kristoferssolo/sula-alus"
+license = "MIT OR Apache-2.0"
+keywords = ["cli", "string", "text", "utility"]
+categories = ["command-line-utilities"]
+exclude = ["/.github", "/.gitignore", "/tests", "*.png", "*.md"]
+readme = "README.md"
 
 [dependencies]
 clap = { version = "4.5", features = ["derive"] }
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e0235a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Sula-Alus CLI
+
+A CLI tool to encode strings and files using Sula-Alus encoding
+
+## Installation
+
+```bash
+cargo install sula-alus
+# or using binstall
+cargo binstall sula-alus
+```
+
+## Usage
+
+### Using on string
+
+```bash
+sula-alus "Some Text" # output: "txeT emoS"
+```
+
+### Using on file
+
+```bash
+sula-alus -f input.txt # output: <encoded file content>
+```
+
+### Outputting to a file
+
+```bash
+sula-alus -f input.txt -o output.txt
+```
+
+## License
+
+This project is dual-licensed under either:
+
+- MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
+
+at your option.