From a4c0f43c9aa141f908a1bef1237a0055e84cda7c Mon Sep 17 00:00:00 2001
From: vijayshinva <vijayshinva>
Date: Sun, 15 Nov 2020 12:46:42 +0530
Subject: [PATCH] Update README

---
 .github/workflows/dotnet-core.yml |  4 ++
 .gitignore                        |  1 +
 README.md                         | 68 +++++++++++++++++++++++++++++++
 3 files changed, 73 insertions(+)
 create mode 100644 .gitignore

diff --git a/.github/workflows/dotnet-core.yml b/.github/workflows/dotnet-core.yml
index 236fe6f..f0812b9 100644
--- a/.github/workflows/dotnet-core.yml
+++ b/.github/workflows/dotnet-core.yml
@@ -19,9 +19,13 @@ jobs:
         dotnet-version: 3.1.301
     - name: Install dependencies
       run: dotnet restore
+      working-directory: Kryptos
     - name: Build
       run: dotnet build --configuration Release --no-restore
+      working-directory: Kryptos
     - name: Test
       run: dotnet test --no-restore --verbosity normal
+      working-directory: Kryptos
     - name: Pack
       run: dotnet pack --configuration Release
+      working-directory: Kryptos
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a4d6d9c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.vs/
\ No newline at end of file
diff --git a/README.md b/README.md
index 13cffb1..b8f9159 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,70 @@
 # kryptos
 A .NET core tool for cryptography.
+
+![.NET Core](https://github.com/vijayshinva/kryptos/workflows/.NET%20Core/badge.svg)
+[![CodeFactor](https://www.codefactor.io/repository/github/vijayshinva/kryptos/badge)](https://www.codefactor.io/repository/github/vijayshinva/kryptos)
+[![NuGet version](https://badge.fury.io/nu/Kryptos.svg)](https://badge.fury.io/nu/Kryptos)
+
+## Overview
+- [Features](#features)
+- [Installation](#installation)
+- [Update](#update)
+- [Usage](#usage)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+- Base64 Encoding and Decoding
+- MD5 Hash
+- SHA-1, SHA-256, SHA-384, SHA-512 Hash
+
+## Installation
+
+**Kryptos** is available as a .NET Global Tool and can be installed using the .NET Core CLI.
+
+```
+dotnet tool install --global Kryptos
+```
+
+## Update
+**Kryptos** is under active development and new features are being added. Update to the latest version using the command below.
+```
+dotnet tool update --global Kryptos
+```
+
+## Usage
+
+```
+kryptos --help
+```
+
+## Examples
+1. Generate Base64 encoded string
+    ```
+    kryptos base64 enc -t "The quick brown fox jumps over the lazy dog."
+    ```
+2. Decode Base64 encoded string
+    ```
+    kryptos base64 dec -t "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4="
+    ```
+3. Generate SHA256 hash of file
+    ```
+    kryptos sha256 hash -i .\ubuntu-20.04-desktop-amd64.iso
+    ```
+
+## Contributing
+- Fork the repo on [GitHub][git-repo]
+- Clone the project to your own machine
+- Commit changes to your own branch
+- Push your work back up to your fork
+- Be sure to pull the latest from "upstream" before making a pull request!
+- Submit a Pull Request so that changes can be reviewed and merged
+
+NOTE: By raising a Pull Request you grant the guardians of this project the necessary ownership or grants of rights over all contributions to distribute under the [chosen license](https://github.com/vijayshinva/kryptos/blob/main/LICENSE).
+
+## LICENSE
+[![license](https://img.shields.io/github/license/vijayshinva/kryptos.svg)](https://github.com/vijayshinva/kryptos/blob/main/LICENSE)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvijayshinva%2Fkryptos.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvijayshinva%2Fkryptos?ref=badge_shield)
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvijayshinva%2Fkryptos.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvijayshinva%2Fkryptos?ref=badge_large)