]> Cypherpunks.ru repositories - gocheese.git/commitdiff
Create sections in README for convenience
authorSergey Matveev <stargrave@stargrave.org>
Sun, 1 Dec 2019 08:28:59 +0000 (11:28 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Sun, 1 Dec 2019 20:42:35 +0000 (23:42 +0300)
README

diff --git a/README b/README
index aae1bb3d1c671af3eeddb9cfb38f7cc240b47b70..555b19b3bb800e76c7549aaf02504fb646931a15 100644 (file)
--- a/README
+++ b/README
@@ -18,6 +18,25 @@ You can upload packages to it with twine:
         --username spam \
         --passwd foo dist/tarball.tar.gz
 
+-refresh URL behaves the same way as -simple one, but is always
+refreshes package versions from PyPI when listing it. You can use it to
+forcefully update package version.
+
+Initially it was created as a fork of https://github.com/c4s4/cheeseshop,
+but nearly all the code was rewritten. It has huge differences:
+
+* no TLS support
+* no YAML configuration, just command-line arguments
+* no package overwriting ability
+* atomic packages store on filesystem
+* proxying and caching of missing packages
+* SHA256-checksummed packages (both uploaded and proxied one)
+
+GoCheese is free software: see the file COPYING for copying conditions.
+
+                        Password authentication
+                        =======================
+
 You have to store your authentication data in a file (specified
 with -passwd option) with following format:
 
@@ -44,6 +63,9 @@ hashed passwords:
     foo:$sha256$fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9
     foo:$argon2i$v=19$m=32768,t=3,p=4$OGU5MTM3YjVlYzQwZjhkZA$rVn53v6Ckpf7WH0676ZQLr9Hbm6VH3YnL6I9ONJcIIU
 
+                         On-disk storage format
+                         ======================
+
 Root directory has the following hierarchy:
 
     root
@@ -66,19 +88,3 @@ tarball is really downloaded and verified against the checksum. For
 example in the root directory above we have downloaded only
 public-package-0.2. Private packages contain .private file, indicating
 that it must not be asked in PyPI if required version is missing.
-
--refresh URL behaves the same way as -simple one, but is always
-refreshes package versions from PyPI when listing it. You can use it to
-forcefully update package version.
-
-Initially it was created as a fork of https://github.com/c4s4/cheeseshop,
-but nearly all the code was rewritten. It has huge differences:
-
-* no TLS support
-* no YAML configuration, just command-line arguments
-* no package overwriting ability
-* atomic packages store on filesystem
-* proxying and caching of missing packages
-* SHA256-checksummed packages (both uploaded and proxied one)
-
-GoCheese is free software: see the file COPYING for copying conditions.