diff --git a/README.md b/docs/README.md similarity index 100% rename from README.md rename to docs/README.md diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d6a21b9 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,9 @@ +site_name: Snyk Tags Tool +nav: + - Home: README.md + +theme: + name: readthedocs + highlightjs: true +plugins: + - search diff --git a/pyproject.toml b/pyproject.toml index 0000259..584f388 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ version = "2.2.1" description = "CLI tool designed to manage tags and attributes at scale" authors = ["EricFernandezSnyk "] license = "MIT" -readme = "README.md" +readme = "docs/README.md" repository = "https://github.com/snyk-labs/snyk-tags-tool" keywords =["snyk"]