mirror of
https://github.com/kristoferssolo/sula-alus.git
synced 2025-10-21 20:00:36 +00:00
docs: add README.md
This commit is contained in:
parent
e5c1dd4f19
commit
2f3bea459c
10
Cargo.toml
10
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"] }
|
||||
|
||||
40
README.md
Normal file
40
README.md
Normal file
@ -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.
|
||||
Loading…
Reference in New Issue
Block a user