diff --git a/README.md b/README.md index 6b9e6b6..6e7fb39 100644 --- a/README.md +++ b/README.md @@ -53,17 +53,20 @@ 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) +You can find documentation in the [docs](docs) folder. -## 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: - - [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 + +### Tutorials +You can find tutorials in the [notebooks](notebooks) directory. + +Recommended order: +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 diff --git a/docs/templates/encipher_decipher_renew_nkode.template.md b/docs/templates/encipher_decipher_renew_nkode.template.md index 57cd368..6831a92 100644 --- a/docs/templates/encipher_decipher_renew_nkode.template.md +++ b/docs/templates/encipher_decipher_renew_nkode.template.md @@ -1,4 +1,4 @@ -# Encipher and Decipher nKode +# Encipher, Decipher and Renew nKode ## Customer Policy - max nkode length: {{ max_nkode_len }}