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 09:15:40 -05:00
parent b9e144243d
commit f7d4e4411f
3 changed files with 125 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -52,10 +52,18 @@ jupyter notebook
jupyter lab
```
## Explore the Docs
1. [nKode Enrollment](docs/enrollment_diagram.md)
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. Navigate to the `/notebooks` directory in the Jupyter interface
2. Open the tutorials in the following recommended order:
- `Enrollment_Login_Renewal.ipynb` - Learn how to manage user accounts in nkode
- `Dispersion.ipynb` - Understand the basic concepts of dispersion in nkode
- `Split_Shuffle.ipynb` - Explore the split shuffle functionality
2. Recommended order:
- [Enrollment_Login_Renewal_Simplified.ipynb](notebooks/Enrollment_Login_Renewal_Simplified.ipynb) - Learn the basics of the nKode API
- [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
- [Split_Shuffle.ipynb](notebooks/Split_Shuffle.ipynb) - Explore the split shuffle functionality