diff --git a/README.md b/README.md index a1c8ff5..ee51a77 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ ![](https://img.shields.io/github/last-commit/darenasc/auto-fes) ![](https://img.shields.io/github/stars/darenasc/auto-fes?style=social) -Automated exploration of files in a folder structure to extract metadata and -potential usage of information. +Automated exploration of files with structured data on them (`csv`, `txt`, +`Excel`) in a folder structure to extract metadata and potential usage of +information. If you have a bunch of sctructured data in plain files, this library is for you. diff --git a/docs/index.md b/docs/index.md index ef597d6..d3abf7b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,8 @@ # Automated File Exploration System -Automated exploration of files in a folder structure to extract metadata and -potential usage of information. +Automated exploration of files with structured data on them (`csv`, `txt`, +`Excel`) in a folder structure to extract metadata and potential usage of +information. If you have a bunch of sctructured data in plain files, this library is for you. diff --git a/mkdocs.yml b/mkdocs.yml index 712ecc9..c6e5a57 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,9 @@ site_name: Auto File Exploration System +site_description: Automated exploration of files. site_url: https://darenasc.github.io/auto-fes/ +repo_url: https://github.com/darenasc/auto-fes/ + theme: name: "material" features: @@ -14,6 +17,8 @@ theme: - content.code.annotation - content.code.copy language: en + hljs_languages: + - python plugins: - search