update readme
This commit is contained in:
30
README.md
30
README.md
@@ -4,13 +4,34 @@
|
|||||||
|
|
||||||
**paste is a simple web app for writing & sharing code.** It's my own take on conventional pastebin sites like _pastebin.com_ or _hastebin_.
|
**paste is a simple web app for writing & sharing code.** It's my own take on conventional pastebin sites like _pastebin.com_ or _hastebin_.
|
||||||
|
|
||||||
|
Anyone can use paste! The official/public instance can be accessed using the endpoints listed below, but you can also [host your own](#host-your-own) if you like!
|
||||||
|
##### 1) In a Web Browser
|
||||||
|
Just go to https://pastes.dev!
|
||||||
|
|
||||||
|
##### 2) From the Command Line
|
||||||
|
You can submit content using netcat.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Pipe in some output from any command
|
||||||
|
> echo "Hello world" | nc nc.pastes.dev 1337
|
||||||
|
|
||||||
|
# Upload the contents of a file
|
||||||
|
> cat example123.txt | nc nc.pastes.dev 1337
|
||||||
|
```
|
||||||
|
|
||||||
|
##### 3) With the API
|
||||||
|
Send GET/POST requests to `https://api.pastes.dev/`. More info [below](#pastesdev-api).
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### About
|
||||||
The frontend _(this repository)_ is written using the React framework. The backend data storage is handled by a separate web service called [bytebin](https://github.com/lucko/bytebin).
|
The frontend _(this repository)_ is written using the React framework. The backend data storage is handled by a separate web service called [bytebin](https://github.com/lucko/bytebin).
|
||||||
|
|
||||||
The user-interface is based on the [Monaco Editor](https://microsoft.github.io/monaco-editor/), the engine behind the popular Visual Studio Code text editor. It's quite simple; it supports syntax highlighting, automatic indentation, many supported languages, themes, zooming in/out, linking to specific lines or sections, and more!
|
The user-interface is based on the [Monaco Editor](https://microsoft.github.io/monaco-editor/), the engine behind the popular Visual Studio Code text editor. It's quite simple; it supports syntax highlighting, automatic indentation, many supported languages, themes, zooming in/out, linking to specific lines or sections, and more!
|
||||||
|
|
||||||
## pastes.dev
|
### pastes.dev
|
||||||
|
|
||||||
I host a public instance at [pastes.dev](https://pastes.dev). Please feel free to use it to share code/configs/whatever!
|
I host a public instance at https://pastes.dev. Please feel free to use it to share code/configs/whatever!
|
||||||
|
|
||||||
Please note that the following (very-non-legally worded) [terms of service](https://github.com/lucko/bytebin#public-instances) apply.
|
Please note that the following (very-non-legally worded) [terms of service](https://github.com/lucko/bytebin#public-instances) apply.
|
||||||
If you come across any content which is illegal or infringes on copyright, please [get in touch](https://lucko.me/contact) and let me know so I can remove it.
|
If you come across any content which is illegal or infringes on copyright, please [get in touch](https://lucko.me/contact) and let me know so I can remove it.
|
||||||
@@ -29,7 +50,10 @@ Uploaded content is retained for 90 days then deleted.
|
|||||||
* The paste "key" is returned in the `Location` header, or in the response body as a JSON object in the format `{"key": "<key>"}`.
|
* The paste "key" is returned in the `Location` header, or in the response body as a JSON object in the format `{"key": "<key>"}`.
|
||||||
|
|
||||||
The API is powered by the [bytebin](https://github.com/lucko/bytebin) service, so more information about how it works can be found there.
|
The API is powered by the [bytebin](https://github.com/lucko/bytebin) service, so more information about how it works can be found there.
|
||||||
## Host your own
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### Host your own
|
||||||
|
|
||||||
It's quite simple to host your own version.
|
It's quite simple to host your own version.
|
||||||
|
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ export default function EditorControls({
|
|||||||
<Button
|
<Button
|
||||||
className="optional"
|
className="optional"
|
||||||
as="a"
|
as="a"
|
||||||
href="https://github.com/lucko/paste"
|
href="https://github.com/lucko/paste#readme"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
rel="noreferrer"
|
rel="noreferrer"
|
||||||
>
|
>
|
||||||
|
|||||||
Reference in New Issue
Block a user