docs: consolidate and update docs, include features and roadmap

README.md

@@ -10,40 +10,46 @@
   <a href="https://crates.io/crates/i6" target="_blank">
     <img src="https://img.shields.io/crates/v/i6?logo=Rust&logoColor=white"/> 
   </a>
-  <br/>
-  <a href="https://hub.docker.com/r/kruserr/i6" target="_blank">
-    <img src="https://img.shields.io/docker/v/kruserr/i6?sort=semver&logo=docker&logoColor=white"/> 
-  </a>
   <a href="https://codecov.io/gh/kruserr/i6" target="_blank"> 
     <img src="https://img.shields.io/codecov/c/gh/kruserr/i6?logo=Codecov&logoColor=white"/> 
   </a>
 </p>
 
 # i6
-A collection of tools
+A collection of cross platform portable cli tools, statically linked into a single binary executable
 
-## Documentation
-Visit the [Documentation](https://docs.rs/i6).
+## Features
+- http or https server in your present working directory
+- simple pack and unpack tool to quickly compress and optionally encrypt files
 
 ## Getting Started
 ### Cargo
 Install and run with cargo
 ```sh
 cargo install --locked i6
-i6
+i6 --help
 ```
 
-### Docker
-Run with docker
-```bash
-docker run -it --rm --name i6 kruserr/i6:0.1
-```
-
-### Git and cargo
-Clone the repo, build from source and run
-```bash
-git clone https://github.com/kruserr/i6.git
-cd i6
-cargo install --locked --path .
-i6
-```
+## Roadmap
+- [x] http or https server in your present working directory
+- [x] simple pack and unpack tool to quickly compress and optionally encrypt files
+- [ ] minimal shell with shell scripting language and a minimal set of unix style coreutils
+- [ ] cli timer that runs in the background and chimes
+- [ ] z fuzzy path finder
+- [ ] http client with verbose setting
+- [ ] hex viewer
+- [ ] cert generator
+- [ ] password generator
+- [ ] sha512sum
+- [ ] df -ht
+- [ ] du -ahd1
+- [ ] htop like resource monitor
+- [ ] neofetch like sysinfo
+- [ ] ftp server
+- [ ] ftp client
+- [ ] ssh server
+- [ ] ssh client
+- [ ] git client
+- [ ] ping sweeper
+- [ ] port scanner
+- [ ] vim like text editor

i6/src/lib.rs

@@ -1,57 +1,2 @@
-#![doc(
-  html_logo_url = "https://raw.githubusercontent.com/kruserr/i6/main/assets/logo/logo.svg",
-  html_favicon_url = "https://raw.githubusercontent.com/kruserr/i6/main/assets/logo/favicon.ico"
-)]
-
-//! <p align="center">
-//!   <a href="https://github.com/kruserr/i6" target="_blank">
-//!     <img width="300" src="https://raw.githubusercontent.com/kruserr/i6/main/assets/logo/logo.svg">
-//!   </a>
-//!   <br/>
-//!   <br/>
-//!   <a href="https://github.com/kruserr/i6/releases" target="_blank">
-//!     <img src="https://img.shields.io/github/v/release/kruserr/i6?sort=semver&logo=GitHub&logoColor=white">
-//!   </a>
-//!   <a href="https://crates.io/crates/i6" target="_blank">
-//!     <img src="https://img.shields.io/crates/v/i6?logo=Rust&logoColor=white"/>
-//!   </a>
-//!   <br/>
-//!   <a href="https://hub.docker.com/r/kruserr/i6" target="_blank">
-//!     <img src="https://img.shields.io/docker/v/kruserr/i6?sort=semver&logo=docker&logoColor=white"/>
-//!   </a>
-//!   <a href="https://codecov.io/gh/kruserr/i6" target="_blank">
-//!     <img src="https://img.shields.io/codecov/c/gh/kruserr/i6?logo=Codecov&logoColor=white"/>
-//!   </a>
-//! </p>
-//!
-//! # i6
-//! A collection of tools
-//!
-//! ## Documentation
-//! Visit the [Documentation](https://docs.rs/i6).
-//!
-//! ## Getting Started
-//! ### Cargo
-//! Install and run with cargo
-//! ```sh
-//! cargo install --locked i6
-//! i6
-//! ```
-//!
-//! ### Docker
-//! Run with docker
-//! ```bash
-//! docker run -it --rm --name i6 kruserr/i6:0.1
-//! ```
-//!
-//! ### Git and cargo
-//! Clone the repo, build from source and run
-//! ```bash
-//! git clone https://github.com/kruserr/i6.git
-//! cd i6
-//! cargo install --locked --path .
-//! i6
-//! ```
-
 pub mod http;
 pub mod timer;