From 369dbe037fbf920f0a9446f2fa0877365d66144e Mon Sep 17 00:00:00 2001
From: fenix <fenix@derfenix.pro>
Date: Mon, 27 Mar 2023 22:37:36 +0300
Subject: [PATCH] Update README.md

---
 .idea/jsonSchemas.xml |  4 ++--
 README.md             | 52 ++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 53 insertions(+), 3 deletions(-)

diff --git a/.idea/jsonSchemas.xml b/.idea/jsonSchemas.xml
index 6fb00f9..b4f859d 100644
--- a/.idea/jsonSchemas.xml
+++ b/.idea/jsonSchemas.xml
@@ -3,10 +3,10 @@
   <component name="JsonSchemaMappingsProjectConfiguration">
     <state>
       <map>
-        <entry key="openapi.json">
+        <entry key="openapi">
           <value>
             <SchemaInfo>
-              <option name="name" value="openapi.json" />
+              <option name="name" value="openapi" />
               <option name="relativePathToSchema" value="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.json" />
               <option name="applicationDefined" value="true" />
               <option name="patterns">
diff --git a/README.md b/README.md
index 06fccb6..7d32251 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,62 @@
 
 Aimed to be a simple, fast and easy-to-use webarchive for personal or home-net usage.
 
+## Requirements 
+
+* Golang 1.19 or higher
+* wkhtmltopdf binary in $PATH (to save pages in pdf)
+
+## Usage
+
+#### 1. Start the server
+
+```shell
+go run ./cmd/server/main.go
+```
+
+#### 2. Add a page
+
+```shell
+curl -X POST --location "http://localhost:5001/pages" \
+    -H "Content-Type: application/json" \
+    -d "{
+          \"url\": \"https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1937\",
+          \"formats\": [
+            \"all\"
+          ]
+        }" | jq .
+```
+
+#### 3. Get the page's info
+
+```shell
+curl -X GET --location "http://localhost:5001/pages/$page_id" | jq .
+```
+where `$page_id` — value of the `id` field from previous command response.
+If `status` field in response is `success` (or `with_errors`) - the `results` field
+will contain all processed formats with ids of the stored files.
+
+#### 4. Open file in browser
+
+```shell
+xdg-open http://localhost:5001/pages/$page_id/file/$file_id
+```
+Where  `$page_id` — value of the `id` field from previous command response, and
+`$file_id` — the id of interesting file.
+
+#### 5. List all stored pages
+
+```shell
+curl -X GET --location "http://localhost:5001/pages" | jq .
+```
+
 ### Roadmap
 
 - [x] Save page to pdf 
 - [x] Save URL headers
 - [ ] Save page to the single-page html
-- [ ] Save page to html with separate resource files
+- [ ] Save page to html with separate resource files (?)
 - [ ] Optional authentication
 - [ ] Multi-user access
 - [ ] Support PostgreSQL
+- [ ] Extend configuration