docs: 0.0.5 polish

PabloLION · Feb 2, 2022 · ef39ba7 · ef39ba7
1 parent a5c042f
commit ef39ba7
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,18 @@
 # symmetric-secrete-share
 
-Share secret files via github with symmetric encryption ed25519.
+CLI to share secret files via github with symmetric encryption ed25519.
 
-- **IMPORTANT: The secret files at should be git-ignored.**
+- **IMPORTANT: The secret files at should be git-ignored to avoid oblivious leakage.**
 - Temporarily supports only text files (only tested with `.env`).
 - Best used to store secrets and configurations.
 - Key should be a 32-byte long string.
 - (FAQ) If you share with GitHub, please notice that there's a 5 minutes cool-down on refreshing. [Details](https://stackoverflow.com/questions/46551413/github-not-update-raw-after-commit)
 
 ## Use
 
-1. Install CLI
-2. Check the [Tutorial](#Tutorial) and `sss --help`
-3. Recommend to set a global key with `sss key`
+1. Install CLI `pip3 install symmetric-secrete-share`.
+2. Check the [Tutorial Chapter](#Tutorial) and `sss --help`.
+3. Recommended: set up a global key chain with `sss key`, or you would have to input key every time.
 4. Get a config like `$REPO_ROOT/test/injection/sss.json`. The json-schema inside will help you write it.
 
 ### inject
@@ -26,8 +26,6 @@ Share secret files via github with symmetric encryption ed25519.
 
 ### share
 
-- **IMPORTANT: The generated secret (`*.encrypted`) at should be git-ignored to avoid oblivious leakage.**
-
 1. Run CLI
 
    ```bash
@@ -39,8 +37,9 @@ Share secret files via github with symmetric encryption ed25519.
 
 ## Contribute
 
-- Created for [Artcoin-Network](https://github.com/Artcoin-Network/), modifying the private repo[Artcoin-Network/artificial-dev-config](https://github.com/Artcoin-Network/artificial-dev-config).
-- Read More in [dev-docs.md](./docs/dev-docs.md)
+- Created for [Artcoin-Network](https://github.com/Artcoin-Network/), modifying the private repo [Artcoin-Network/artificial-dev-config](https://github.com/Artcoin-Network/artificial-dev-config).
+- To contribute, please fork the repo and run `poetry install`.
+- Read more in [dev-docs.md](./docs/dev-docs.md)
 
 ## Tutorial
 

diff --git a/docs/dev-docs.md b/docs/dev-docs.md
@@ -1,5 +1,22 @@
 # Development Documentation
 
+## Version
+
+### 0.0.5
+
+- Publish to PyPI
+
+### 0.0.4
+
+- Add `poetry`
+- Add and chang json schema many times.
+- Finish DEV LOG 7~15.
+
+### 0.0.2
+
+- Work in [Artcoin-Network/artificial-dev-config](https://github.com/Artcoin-Network/artificial-dev-config).
+- Finish DEV LOG 1~6.
+
 ## DEV LOG
 
 1. (DONE) Add a script to generate different files from one same file. We always use `.env`

diff --git a/pyproject.toml b/pyproject.toml
@@ -3,13 +3,20 @@ authors = ["Pablion <[email protected]>"]
 description = "Share secret files via github with symmetric encryption ed25519."
 license = "Apache-2.0"
 name = "symmetric-secrete-share"
+packages = [
+  {include = "sss_cli"},
+]
 readme = "README.md"
-version = "0.0.4"
+version = "0.0.5"
+
+[tool.poetry.urls]
+documentation = "https://github.com/PabloLION/symmetric-secrete-share"
+homepage = "https://github.com/PabloLION/symmetric-secrete-share"
+repository = "https://github.com/PabloLION/symmetric-secrete-share"
 
 [tool.poetry.scripts]
 sss = "sss_cli.__main__:app"
 symmetric-secrete-share = "sss_cli.__main__:app"
-tts = 'sss_cli.__main__:app'
 
 [tool.poetry.dependencies]
 PyNaCl = "^1.5.0"

diff --git a/res/sss.schema.json b/res/sss.schema.json
@@ -49,7 +49,7 @@
     "sss_version": {
       "description": "Version of symmetric_secrete_share",
       "enum": [
-        "0.0.4"
+        "0.0.5"
       ],
       "type": "string"
     }

diff --git a/sss_cli/__init__.py b/sss_cli/__init__.py
@@ -1,2 +1,2 @@
 APP_NAME = "symmetric_secrete_share"
-__version__ = "0.0.4"
+__version__ = "0.0.5"
diff --git a/tests/injection/sss.json b/tests/injection/sss.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/PabloLION/symmetric-secrete-share/main/res/sss.schema.json",
   "$dev_schema": "./../../res/sss.schema.json",
-  "sss_version": "0.0.4",
+  "sss_version": "0.0.5",
   "config_id": "sss-example",
   "key_identifier": "test_key",
   "last_key_rotation": 0,