Update Documents.

openzim · Jul 20, 2023 · 349a02e · 349a02e
1 parent 9f1ea40
commit 349a02e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -11,6 +11,7 @@ as of 1.3.0.
 ### Added
 
 - Add urls support to collections. (#59)
+- Add archiveless collection.json support. (#60)
 
 ## [1.1.1] - 2023-05-05
 

diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ The user-interface only gives access to files referenced properly in the collect
 
 At the moment, the JSON file needs to provide the following fields for each item in an array:
 
-``` JSON
+```json
 [
     {
         "title": "...",
@@ -79,13 +79,13 @@ Either inside the archive ZIP as `/about.html` or elsewhere, specified via `--ab
 
 ## docker
 
-```
+```sh
 docker run -v my_dir:/output ghcr.io/openzim/nautilus nautiluszim --help
 ```
 
 ## pip
 
-```
+```sh
 pip install nautiluszim
 nautiluszim --help
 ```
@@ -101,9 +101,14 @@ nautiluszim --help
 
 # Usage
 
-```
+```sh
 nautiluszim --archive my-content.zip
 ```
+Or
+```sh
+nautiluszim --collection https://example.com/to-your-collection-file
+# In this mode every file entry must have a valid url.
+```
 
 ## Notes