From d05a3c8c2a0a18eeb37c9c1353a076f573c7ed7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Miguel?= <36349314+vrmiguel@users.noreply.github.com> Date: Tue, 5 Jan 2021 03:37:41 -0300 Subject: [PATCH] Use Markdown instead of ORG mode --- README.org => README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) rename README.org => README.md (92%) diff --git a/README.org b/README.md similarity index 92% rename from README.org rename to README.md index 6b7f35a..078b273 100644 --- a/README.org +++ b/README.md @@ -1,8 +1,8 @@ -#+TITLE: Shrimp (WIP) +# Shrimp -Simple password generator writen in Rust. +Simplistic password generator writen in Rust. -# Installation +## Installation ```shell # Clone the repository @@ -11,13 +11,13 @@ cd shrimp # Change directory into it: cargo run --release # Build it with Cargo ``` -# Example +## Example $ shrimp --length=20 Password: 7TS@utsKi*4peY5bIX7C Quality: Excellent -# Usage +## Usage USAGE: shrimp [FLAGS] [OPTIONS]