From c433b5dd966f574b240948c9ddd46733a49edc67 Mon Sep 17 00:00:00 2001 From: Eli Date: Wed, 1 Jan 2025 11:17:33 -0600 Subject: [PATCH] Update project icons --- README.md | 33 ++++++++++++++------------------- docs/assets/logo-dark.svg | 2 +- docs/assets/logo-light.svg | 2 +- 3 files changed, 16 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d4caca7..20b0c10 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,11 @@ - - - SplitMe-AI Logo + + + SplitMe-AI Logo - -

Break down your docs. Build up your knowledge.

@@ -24,20 +19,20 @@

- GitHub Actions + GitHub Actions - Coverage + Coverage - PyPI Version + PyPI Version - Python Version + Python Version - MIT License - + MIT License +

@@ -49,7 +44,7 @@ ## What is SplitmeAI? -`SplitmeAI` is a Python module that addresses challenges in managing large Markdown files, particularly when creating and maintaining structured static documentation websites such as [Mkdocs][mkdocs]. +SplitmeAI is a Python module that addresses challenges in managing large Markdown files, particularly when creating and maintaining structured static documentation sites such as [Mkdocs][mkdocs]. __Key Features:__ @@ -67,7 +62,7 @@ __Key Features:__ ### Installation -Install from [PyPI][pypi] using any of the package managers listed below. +Install from [PyPI][pypi] using your preferred package manager listed below. ####  pip @@ -141,7 +136,7 @@ splitme-ai \ View the output generated for [splitting on heading level 4 here](./examples/output-h4). >[!NOTE] -> The Official Documentation site with extensive examples and usage instructions is under development Stay tuned for updates! +> Explore the [Official Documentation][docs] for more detailed guides and examples. --- @@ -163,7 +158,7 @@ Contributions are welcome! For bug reports, feature requests, or questions, plea ## License -Copyright © 2024 [splitme-ai][splitme-ai].
+Copyright © 2024-2025 [splitme-ai][splitme-ai].
Released under the [MIT][mit-license] license.
@@ -191,4 +186,4 @@ Released under the [MIT][mit-license] license. [pipx]: https://pipx.pypa.io/stable/ [uv]: https://docs.astral.sh/uv/ [mkdocs]: https://www.mkdocs.org/ -[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/ \ No newline at end of file +[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/ diff --git a/docs/assets/logo-dark.svg b/docs/assets/logo-dark.svg index 6dd647e..c0d6f60 100644 --- a/docs/assets/logo-dark.svg +++ b/docs/assets/logo-dark.svg @@ -1,4 +1,4 @@ - + diff --git a/docs/assets/logo-light.svg b/docs/assets/logo-light.svg index 24bb9f3..aa13731 100644 --- a/docs/assets/logo-light.svg +++ b/docs/assets/logo-light.svg @@ -1,4 +1,4 @@ - +