schrottkatze/karton
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 2 Packages Wiki Activity
karton/README.MD

77 lines
3.3 KiB
Text
Raw Normal View History

Added auto removal of expired pastas
2022-04-11 13:41:28 +00:00
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
![Screenshot](.github/index.png)
Added auto removal of expired pastas
2022-04-11 13:41:28 +00:00
Removed logo from README.MD Because GitHub does not render HTML in Markdown files (correctly anyway)
2022-11-07 15:59:47 +00:00
# MicroBin
Added cargo information and readme badges
2022-06-04 23:20:23 +00:00
![Build](https://github.com/szabodanika/microbin/actions/workflows/rust.yml/badge.svg)
![crates.io](https://img.shields.io/crates/v/microbin.svg)
Update README.MD
2022-09-26 12:10:01 +00:00
[![Docker Image](https://github.com/szabodanika/microbin/actions/workflows/docker.yml/badge.svg)](https://hub.docker.com/r/danielszabo99/microbin)
Update README.MD
2022-11-14 19:24:08 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/danielszabo99/microbin?label=Docker%20pulls)](https://img.shields.io/docker/pulls/danielszabo99/microbin?label=Docker%20pulls)
[![Support Server](https://img.shields.io/discord/662017309162078267.svg?color=7289da&label=Discord&logo=discord&style=flat-square)](https://discord.gg/3DsyTN7T)
Added cargo information and readme badges
2022-06-04 23:20:23 +00:00
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
Update README.MD
2022-04-23 15:57:45 +00:00
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
Install from Cargo:
Add "Deploy to Render" button to README.MD
2022-06-04 22:05:47 +00:00
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
```bash
cargo install microbin
```
Added cargo information and readme badges
2022-06-04 23:20:23 +00:00
And run with your custom configuration:
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
```bash
microbin --port 8080 --public-path https://myserver.net --highlightsyntax --editable
```
Add "Deploy to Render" button to README.MD
2022-06-04 22:05:47 +00:00
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
Or get the Docker Image from [Dockerhub: danielszabo99/microbin](https://hub.docker.com/r/danielszabo99/microbin).
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
On our website [microbin.eu](https://microbin.eu) you will find the following:
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
- [Screenshots](https://microbin.eu/screenshots/)
- [Quickstart Guide](https://microbin.eu/quickstart/)
- [Documentation](https://microbin.eu/documentation/)
- [Donations and Sponsorhip](https://microbin.eu/donate/)
- [Community](https://microbin.eu/community/)
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
## Features
Update README.MD
2022-04-23 15:57:45 +00:00
- Is very small
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
- Entirely self-contained executable, MicroBin is a single file!
Update README.MD
2022-04-23 15:57:45 +00:00
- Animal names instead of random numbers for pasta identifiers (64 animals)
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
- File uploads (eg. `server.com/file/pig-dog-cat`)
- Raw text serving (eg. `server.com/raw/pig-dog-cat`)
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- URL shortening and redirection
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
- QR code support
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- Very simple database (JSON + files) for portability, easy backups and integration
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
- Listing and manually removing pastas (`/pastalist`)
Update README.MD - Moved documentation to website - Updated screenshots - Added logo - Reorganised feature list - Added licence at the bottom - Moved screenshot to .git folder
2022-11-07 15:57:50 +00:00
- Private and public, editable and final, automatically and never expiring pastas
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- Syntax highlighting
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
- Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see [`water.css`](https://github.com/kognise/water.css))
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- Most of the above can be toggled on and off!
add flag to docs
2022-10-01 06:12:24 +00:00
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
## What is a "pasta" anyway?
In MicroBin, a pasta can be:
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- 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.
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
## When is MicroBin useful?
You can use MicroBin:
Multiple enhancements and bugfixes !Breaking change! - The updated version will not be able to read your old database file Major improvements: - Added editable pastas - Added private pastas - Added line numbers - Added support for wide mode (1080p instead of 720p) - Added syntax highlighting support - Added read-only mode - Added built-in help page - Added option to remove logo, change title and footer text Minor improvements: - Improved looks in pure html mode - Removed link to GitHub repo from navbar - Broke up 7km long main.rs file into smaller modules - Moved water.css into a template instead of serving it as an external resource - Made Save button a bit bigger - Updated README.MD Bugfixes: - Fixed a bug where an incorrect animal ID in a request would cause a crash - Fixed a bug where an empty or corrupt JSON database would cause a crash
2022-06-03 16:24:34 +00:00
- As a URL shortener/redirect service,
- To send long texts to other people,
- To send large files to other people,
- To serve content on the web, eg. configuration files for testing, images, or any other file content using the Raw functionality,
- To move files between your desktop and a server you access from the console,
- As a "postbox" service where people can upload their files or texts, but they cannot see or remove what others sent you - just disable the pastalist page
- To take notes! Simply create an editable pasta.
...and many other things, why not get creative?
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
MicroBin and MicroBin.eu are available under the [BSD 3-Clause License](LICENSE).
add flag to docs
2022-10-01 06:12:24 +00:00
Clean up README * microbin.eu reference was not working * Consistent MicroBin spelling * Link to LICENSE * Clean up whitespace * Insert codeblocks * Set heading 2 instead of heading 3 (as h1 was already used by the title, next in line would be h2) * Set monospace for some references
2022-11-09 18:55:13 +00:00
© Dániel Szabó 2022
Reference in a new issue Copy permalink