Skip to content

Commit

Permalink
Update README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
darenasc committed Dec 23, 2024
1 parent ce814f5 commit 26d2067
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -14,6 +17,8 @@ theme:
- content.code.annotation
- content.code.copy
language: en
hljs_languages:
- python

plugins:
- search
Expand Down

0 comments on commit 26d2067

Please sign in to comment.