diff --git a/README.md b/README.md index 5284272..87c11de 100644 --- a/README.md +++ b/README.md @@ -15,22 +15,22 @@ pip install nbdefense ## 🙋‍♂️ What is NB Defense? -Brought to you by Protect AI, NB Defense is a CLI tool and SDK that encourages you to think about security throughout every step of your machine learning development process. You can use nbdefense to scan for [Secrets](https://nbdefense.ai/supported-scans/detecting-secrets), [Personally Identifiable Information (PII)](https://nbdefense.ai/supported-scans/detecting-PII), [Common Vulnerabilities and Exposures(CVE)](https://nbdefense.ai/supported-scans/detecting-CVEs), and [Licenses](https://nbdefense.ai/supported-scans/detecting-licenses) in your notebook and dependency files. +Brought to you by Protect AI, NB Defense is a CLI tool and SDK that encourages you to think about security throughout every step of your machine learning development process. You can use nbdefense to scan for [Secrets](https://github.com/protectai/nbdefense/blob/main/docs/docs/supported-scans/detecting-secrets.md), [Personally Identifiable Information (PII)](https://github.com/protectai/nbdefense/blob/main/docs/docs/supported-scans/detecting-PII.md), [Common Vulnerabilities and Exposures(CVE)](https://github.com/protectai/nbdefense/blob/main/docs/docs/supported-scans/detecting-CVEs.md), and [Licenses](https://github.com/protectai/nbdefense/blob/main/docs/docs/supported-scans/detecting-licenses.md) in your notebook and dependency files. -NB Defense also acts as a SDK for our [Jupyter Lab Extension](https://github.com/protectai/nbdefense-jupyter). Visit our [documentation](https://nbdefense.ai), or the repository below to learn more. +NB Defense also acts as a SDK for our [Jupyter Lab Extension](https://github.com/protectai/nbdefense-jupyter). Visit our [documentation](https://github.com/protectai/nbdefense/tree/main/docs/docs), or the repository below to learn more. - [Jupyter Lab Extension Repository](https://github.com/protectai/nbdefense-jupyter) ## 📄 Documentation -For more details and [documentation](https://nbdefense.ai) visit these links: +For more details and [documentation](https://github.com/protectai/nbdefense/tree/main/docs/docs) visit these links: -- [Documentation](https://nbdefense.ai) +- [Documentation](https://github.com/protectai/nbdefense/tree/main/docs/docs) -- [Getting Started on a Local Machine](https://nbdefense.ai/getting-started/cli) +- [Getting Started on a Local Machine](https://github.com/protectai/nbdefense/blob/main/docs/docs/getting-started/cli.md) ## 💪 Contributing Welcome to the team! We are open to contributions and working with the community to make notebooks safer for everyone. -If you would like to contribute, please visit [CONTRIBUTING.md](https://github.com/protectai/nbdefense/blob/main/CONTRIBUTING.md) to get started as a developer, or to suggest bug fixes, improvements, or new features follow [this link](https://nbdefense.ai/faq) to our FAQ page. +If you would like to contribute, please visit [CONTRIBUTING.md](https://github.com/protectai/nbdefense/blob/main/CONTRIBUTING.md) to get started as a developer, or to suggest bug fixes, improvements, or new features follow [this link](https://github.com/protectai/nbdefense/blob/main/docs/docs/faq.md) to our FAQ page.