diff --git a/README.MD b/README.MD index a41cd4b..3db54ba 100644 --- a/README.MD +++ b/README.MD @@ -13,15 +13,19 @@ MicroBin is a super tiny, feature rich, configurable, self-contained and self-ho Install from Cargo: -`cargo install microbin` +```bash +cargo install microbin +``` And run with your custom configuration: -`microbin --port 8080 --public-path https://myserver.net --highlightsyntax --editable` +```bash +microbin --port 8080 --public-path https://myserver.net --highlightsyntax --editable +``` -Or get the Docker image from [Dockerhub: danielszabo99/microbin](https://hub.docker.com/r/danielszabo99/microbin) +Or get the Docker Image from [Dockerhub: danielszabo99/microbin](https://hub.docker.com/r/danielszabo99/microbin). -On our website [microbin.eu](microbin.eu) you will find the following: +On our website [microbin.eu](https://microbin.eu) you will find the following: - [Screenshots](https://microbin.eu/screenshots/) - [Quickstart Guide](https://microbin.eu/quickstart/) @@ -29,31 +33,34 @@ On our website [microbin.eu](microbin.eu) you will find the following: - [Donations and Sponsorhip](https://microbin.eu/donate/) - [Community](https://microbin.eu/community/) -### Features +## Features + - Is very small - Entirely self-contained executable, MicroBin is a single file! - Animal names instead of random numbers for pasta identifiers (64 animals) -- File uploads (eg. server.com/file/pig-dog-cat) -- Raw text serving (eg. server.com/raw/pig-dog-cat) +- File uploads (eg. `server.com/file/pig-dog-cat`) +- Raw text serving (eg. `server.com/raw/pig-dog-cat`) - URL shortening and redirection - QR code support - Very simple database (JSON + files) for portability, easy backups and integration -- Listing and manually removing pastas (/pastalist) +- Listing and manually removing pastas (`/pastalist`) - Private and public, editable and final, automatically and never expiring pastas - Syntax highlighting -- Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see [water.css](https://github.com/kognise/water.css)) +- Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see [`water.css`](https://github.com/kognise/water.css)) - Most of the above can be toggled on and off! -### What is a "pasta" anyway? +## What is a "pasta" anyway? + +In MicroBin, a pasta can be: -In microbin, a pasta can be: - A text that you want to paste from one machine to another, eg. some code, - A file that you want to share, eg. a video that is too large for Discord, a zip with a code project in it or an image, - A URL redirect. -### When is MicroBin useful? +## When is MicroBin useful? + +You can use MicroBin: -You can use MicroBin - As a URL shortener/redirect service, - To send long texts to other people, - To send large files to other people, @@ -64,8 +71,6 @@ You can use MicroBin ...and many other things, why not get creative? -### License - -MicroBin and MicroBin.eu are available under the BSD 3-Clause License. +MicroBin and MicroBin.eu are available under the [BSD 3-Clause License](LICENSE). © Dániel Szabó 2022