root/pastebin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Kaczanowski Mateusz 2020-10-27 14:25:08 +01:00
parent a8e8476c9c
commit 7cfe2fc5dc
2 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -1,6 +1,6 @@
[package] [package]
name = "pastebin" name = "pastebin"
version = "0.1.2" version = "0.1.3"
authors = ["Kaczanowski Mateusz <kaczanowski.mateusz@gmail.com>"] authors = ["Kaczanowski Mateusz <kaczanowski.mateusz@gmail.com>"]
edition = "2018" edition = "2018"

13
README.md
View file

@ -44,6 +44,19 @@ This is a rust version of Pastebin service with [rocksdb](https://rocksdb.org/)
* GUI - the UI is a plain HTML with [Bootstrap JS](https://getbootstrap.com/), [jQuery](https://jquery.com/) and [prism.js](https://prismjs.com/) * GUI - the UI is a plain HTML with [Bootstrap JS](https://getbootstrap.com/), [jQuery](https://jquery.com/) and [prism.js](https://prismjs.com/)
* Encryption - password-protected pastes are AES encrypted/decprypted in the browser via [CryptoJS](https://code.google.com/archive/p/crypto-js/) * Encryption - password-protected pastes are AES encrypted/decprypted in the browser via [CryptoJS](https://code.google.com/archive/p/crypto-js/)
### Plugins
The default configuration enables only one plugin, this is syntax highlighting through `prism.js`. This should be enough for p90 of the users but if you need extra features you might want to use the plugin system (`src/plugins`).
To enable additional plugins, pass:
```
--plugins prism <custom_plugin_name>
```
Currently supported:
* [prism.js](https://prismjs.com/)
* [mermaid.js](https://github.com/mermaid-js/mermaid)
## Usage ## Usage
Pastebin builds only with `rust-nightly` version and requires `llvm` compiler (rocksdb deps). To skip the build process, you can use the docker image. Pastebin builds only with `rust-nightly` version and requires `llvm` compiler (rocksdb deps). To skip the build process, you can use the docker image.