dkelly/pynkode
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Donovan
2025-03-26 10:28:42 -05:00
parent f7d4e4411f
commit daed7fad6f
2 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -53,17 +53,20 @@ jupyter lab
``` ```
## Explore the Docs ## Explore the Docs
1. [nKode Enrollment](docs/enrollment_diagram.md) You can find documentation in the [docs](docs) folder.
2. [nKode Login](docs/login_diagram.md)
3. [Encipher nKode](docs/encipher_decipher_renew_nkode.md#nkode-cipher)
4. [Valid nKode](docs/encipher_decipher_renew_nkode.md#validate-nkode)
5. [Renew nKode](docs/encipher_decipher_renew_nkode.md#renew-nkode)
## Exploring the Tutorials 1. [Enrollment](docs/enrollment_diagram.md)
2. [Login](docs/login_diagram.md)
3. [nKode Cipher](docs/encipher_decipher_renew_nkode.md#nkode-cipher)
4. [nKode Validation](docs/encipher_decipher_renew_nkode.md#validate-nkode)
5. [Renew](docs/encipher_decipher_renew_nkode.md#renew-nkode)
1. Navigate to the `/notebooks` directory in the Jupyter interface
2. Recommended order: ### Tutorials
- [Enrollment_Login_Renewal_Simplified.ipynb](notebooks/Enrollment_Login_Renewal_Simplified.ipynb) - Learn the basics of the nKode API You can find tutorials in the [notebooks](notebooks) directory.
- [Enrollment_Login_Renewal_Detailed.ipynb](notebooks/Enrollment_Login_Renewal_Detailed.ipynb) - Learn the nKode API in detail
- [Dispersion.ipynb](notebooks/Dispersion.ipynb)- Understand the basic concepts of dispersion in nkode Recommended order:
- [Split_Shuffle.ipynb](notebooks/Split_Shuffle.ipynb) - Explore the split shuffle functionality 1. [Enrollment_Login_Renewal_Simplified.ipynb](notebooks/Enrollment_Login_Renewal_Simplified.ipynb) - Learn the basics of the nKode API
2. [Enrollment_Login_Renewal_Detailed.ipynb](notebooks/Enrollment_Login_Renewal_Detailed.ipynb) - Learn the nKode API in detail
3. [Dispersion.ipynb](notebooks/Dispersion.ipynb)- Understand the basic concepts of dispersion in nkode
4. [Split_Shuffle.ipynb](notebooks/Split_Shuffle.ipynb) - Explore the split shuffle functionality

2
docs/templates/encipher_decipher_renew_nkode.template.md vendored
View File

@@ -1,4 +1,4 @@
# Encipher and Decipher nKode # Encipher, Decipher and Renew nKode
## Customer Policy ## Customer Policy
- max nkode length: {{ max_nkode_len }} - max nkode length: {{ max_nkode_len }}