diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a645d6 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# jarvis-core + +Core functionality of [JARVIS](https://git.zevaryx.com/jarvis) + +## Modules + +### `jarvis_core.config` + +Configuration management + +### `jarvis_core.db` + +Database connectors and model implementations + +### `jarvis_core.filters` + +Regex filters for various functions + +### `jarvis_core.util` + +Quality of life utilities diff --git a/README.rst b/README.rst deleted file mode 100644 index b52b6ea..0000000 --- a/README.rst +++ /dev/null @@ -1,28 +0,0 @@ -=========== -jarvis-core -=========== - -Core functionality of `JARVIS `_ - -Modules -======= - -``jarvis_core.config`` ----------------------- - -Configuration management - -``jarvis_core.db`` ------------------- - -Database connectors and model implementations - -``jarvis_core.filters`` ------------------------ - -Regex filters for various functions - -``jarvis_core.util`` --------------------- - -Quality of life utilities