Clearing Keys + README

This commit is contained in:
2023-10-26 21:37:26 +02:00
parent 2a15a460d0
commit 833960b23f
5 changed files with 121 additions and 48 deletions

98
README.md Normal file
View File

@@ -0,0 +1,98 @@
<div align="center">
<h1 align="center">
<img src="https://upload.wikimedia.org/wikipedia/en/3/35/Pastebin.com_logo.png" width="100" />
<br>PASTEBIN-CLI</h1>
<h3>◦ A simple CLI to use pastebin in your terminal</h3>
<h3>◦ Developed with the software and tools below.</h3>
<p align="center">
<img src="https://img.shields.io/badge/OpenSSL-721412.svg?style=flat-square&logo=OpenSSL&logoColor=white" alt="OpenSSL" />
<img src="https://img.shields.io/badge/Rust-000000.svg?style=flat-square&logo=Rust&logoColor=white" alt="Rust" />
<img src="https://img.shields.io/badge/Hyper-000000.svg?style=flat-square&logo=Hyper&logoColor=white" alt="Hyper" />
</p>
<img src="https://img.shields.io/github/last-commit/Tilo-K/pastebin-cli?style=flat-square&color=5D6D7E" alt="git-last-commit" />
<img src="https://img.shields.io/github/commit-activity/m/Tilo-K/pastebin-cli?style=flat-square&color=5D6D7E" alt="GitHub commit activity" />
<img src="https://img.shields.io/github/languages/top/Tilo-K/pastebin-cli?style=flat-square&color=5D6D7E" alt="GitHub top language" />
</div>
---
## 📖 Table of Contents
- [📖 Table of Contents](#-table-of-contents)
- [📍 Overview](#-overview)
- [📦 Features](#-features)
- [📂 repository Structure](#-repository-structure)
- [⚙️ Modules](#modules)
- [🚀 Getting Started](#-getting-started)
- [🔧 Installation](#-installation)
- [🤖 Running pastebin-cli](#-running-pastebin-cli)
---
## 📦 Features
- Creating new pastes
- Reading pastes
- Deleting pastes
---
## 📂 Repository Structure
```sh
└── pastebin-cli/
├── Cargo.lock
├── Cargo.toml
└── src/
├── keys.rs
├── main.rs
└── pastebin.rs
```
---
---
## 🚀 Getting Started
### 🔧 Installation
```sh
cargo install pastebin-cli
```
### 🔧 Installation via Source Code
1. Clone the pastebin-cli repository:
```sh
git clone https://github.com/Tilo-K/pastebin-cli
```
2. Change to the project directory:
```sh
cd pastebin-cli
```
3. Install the dependencies:
```sh
cargo install .
```
### 🤖 Running pastebin-cli
```sh
pastebin-cli
```
---
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/Tilo-K/pastebin-cli/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/Tilo-K/pastebin-cli/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/Tilo-K/pastebin-cli/issues)**: Submit bugs found or log feature requests for TILO-K.