From 626633a7a9dc13f14b51966e64df955aca486cd2 Mon Sep 17 00:00:00 2001 From: Kumi Date: Mon, 22 Jan 2024 08:44:37 +0100 Subject: [PATCH] Add file transfer instructions to README Enhanced the README with clear examples for uploading and downloading files, and for interaction with pastes via curl or browser. This update should assist users in performing common tasks without needing to refer to external documentation, improving ease of use. --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 5a1420d..3878671 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,12 @@ With the exception of the `-u` option, all arguments of the original Fiche should work as expected. `-u` is not implemented because, well, just use the right user in the first place. 🤷‍♀️ +#### Uploading files + +```bash +$ nc < +``` + ### Recup Server ```bash @@ -45,6 +51,14 @@ $ source venv/bin/activate $ pyfiche-recup # try --help for options ``` +#### Downloading files + +Pipe the ID of an uploaded file to `nc`: + +```bash +$ echo | nc > +``` + ### Lines Server ```bash @@ -52,6 +66,28 @@ $ source venv/bin/activate $ pyfiche-lines # try --help for options ``` +#### Viewing pastes in a browser + +Go to `http://:/`. + +#### Downloading raw pastes + +```bash +$ curl http://://raw +``` + +#### Uploading pastes + +```bash +$ curl -X POST -d '' http://: +``` + +Or use a file: + +```bash +$ curl -X POST -d @ http://: +``` + ## License PyFiche is licensed under the MIT license. See the [LICENSE](LICENSE) file for