chore(readme): upate

retrofor · Feb 22, 2024 · 4fe3918 · 4fe3918
1 parent c10c22a
commit 4fe3918
Showing 1 changed file with 81 additions and 41 deletions.
diff --git a/README.rst b/README.rst
@@ -1,59 +1,99 @@
-.. image:: https://img.shields.io/discord/1063871387527303188?style=flat-square
-   :target: https://discord.gg/9vG9352RXS
+.. raw:: html
 
-.. image:: https://img.shields.io/badge/-QQ群%20761859776-002FA7?style=flat-square&logo=Tencent QQ&logoColor=white
-   :target: https://jq.qq.com/?_wv=1027&k=OOUmgrqx
+   <a href="https://discord.gg/9vG9352RXS">
+   <img alt="Discord" src="https://img.shields.io/discord/1063871387527303188?style=flat-square">
+   </a>
+   <a href="https://jq.qq.com/?_wv=1027&k=OOUmgrqx">
+   <img alt="QQ群" src="https://img.shields.io/badge/-QQ群%20761859776-002FA7?style=flat-square&logo=Tencent QQ&logoColor=white">
+   </a>
+   <a href="https://pypi.python.org/pypi/iamai">
+     <!-- <img src="https://img.shields.io/pypi/v/iamai?style=flat-square" alt="pypi"> -->
+     <img src="https://img.shields.io/badge/stable version-v0.0.2+march-blue?style=flat-square&logo=python" alt="python">
+   </a><a href='https://iamai.is-a.dev/en/latest/?badge=latest'>
+       <img src='https://readthedocs.org/projects/iamai/badge/?version=latest' alt='Documentation Status' />
+   </a>
 
-.. image:: https://img.shields.io/badge/stable version-v0.0.2+march-blue?style=flat-square&logo=python
-   :target: https://pypi.python.org/pypi/iamai
+.. raw:: html
 
-.. image:: https://readthedocs.org/projects/iamai/badge/?version=latest
-   :target: https://iamai.is-a.dev/en/latest/?badge=latest
-
-.. image:: https://images.repography.com/40962158/retrofor/iamai/structure/afEhYzXo83AMGRNy9EzPPQcX9ECBKj2gOPhvmpzMFSg/DQMxDEhfNZdq6zFhjPa1G61Bg9g-DRhQiwNY-W2ZHVE_table.svg
-   :width: 60
-   :align: right
+   <img width="60" align="right" src="https://images.repography.com/40962158/retrofor/iamai/structure/afEhYzXo83AMGRNy9EzPPQcX9ECBKj2gOPhvmpzMFSg/DQMxDEhfNZdq6zFhjPa1G61Bg9g-DRhQiwNY-W2ZHVE_table.svg" />
 
 Comprehensive AI Toolkit for Multimodal Learning and Cross-Platform Robotics
-==============================================================================
+============================================================================
 
-.. index-start
-Welcome to iamai, a powerful and comprehensive AI toolkit that seamlessly integrates multimodal machine learning capabilities with advanced tools for cross-platform robot development!
+.. raw:: html
 
-  🌍 This library is designed to provide developers with a unified solution for creating intelligent systems that span multiple modalities and operate across diverse platforms.
+   <!-- start intro -->
 
-- 🎪 Interactive docs & demos
-- 🕶 Seamless migration: Works for both Rasa and GPT and more...
-- ⚡ Fully tree shakeable: Only take what you want, bundle size
-- 🔩 Flexible: Configurable event filters and targets
-- 🔌 Optional Add-ons: Apscheduler, etc.
-- 👍 Cross-platform: dingtalk etc.
-.. index-end
+Welcome to iamai, a powerful and comprehensive AI toolkit that
+seamlessly integrates multimodal machine learning capabilities with
+advanced tools for cross-platform robot development!
 
-First of all, in the field of machine learning, we drew inspiration from the excellent design of `Hugging Face`_'s `transformers`_ for the use of pre-trained models. We would like to express our gratitude to the authors of Hugging Face and their open-source community.
+   🌍 This library is designed to provide developers with a unified
+   solution for creating intelligent systems that span multiple
+   modalities and operate across diverse platforms.
 
-Secondly, regarding the cross-platform robot framework, it is primarily based on `st`_'s `alicebot`_. We have made numerous adaptations to make it compatible with machine learning. We would like to thank the st and alicebot open-source communities for their contributions.
+.. raw:: html
 
-To avoid any potential disputes or misunderstandings, we have listed the licenses of the projects we have used and express our gratitude towards them. please see `credits.pdf`_.
+   <!-- end intro -->
 
-----
+.. raw:: html
 
-`MIT`_ © 2023-PRESENT `Retro for Wut?`_.
+   <!-- start index -->
 
-|FOSSA Status|
+-  🎪
+   **Interactive**\ `docs <https://iamai.is-a.dev>`__\ **&**\ `demos <https://iamai.is-a.dev/>`__
+-  🕶 **Seamless migration**: Works for **both** `Rasa <>`__ and
+   `GPT <>`__ and more...
+-  ⚡ **Fully tree shakeable**: Only take what you want, `bundle
+   size <https://iamai.retrofor.space/export-size>`__
+-  🔩 **Flexible**: Configurable event filters and targets
+-  🔌 **Optional**\ `Add-ons <https://iamai.retrofor.space/add-ons>`__:
+   `Apscheduler <https://iamai.retrofor.space/add-ons/apscheduler>`__,
+   etc.
+-  👍 **Cross-platform**:
+   `dingtalk <https://iamai.retrofor.space/guide/dingtalk-adapter.html>`__
+   etc.
+
+.. raw:: html
+
+   <!-- end index -->
+
+First of all, in the field of machine learning, we drew inspiration from
+the excellent design of `Hugging Face <https://huggingface.co>`__'s
+`transformers <https://github.com/huggingface/transformers>`__ 🤗 for
+the use of pre-trained models. We would like to express our gratitude to
+the authors of Hugging Face and their open-source community.
+
+Secondly, regarding the cross-platform robot framework, it is primarily
+based on `st <https://github.com/st1020>`__'s
+`alicebot <https://github.com/AliceBotProject/alicebot>`__. We have made
+numerous adaptations to make it compatible with machine learning. We
+would like to thank the st and alicebot open-source communities for
+their contributions.
+
+To avoid any potential disputes or misunderstandings, we have listed the
+licenses of the projects we have used and express our gratitude towards
+them. please see `credits.md <./docs/source/credits.md>`__.
+
+.. raw:: html
 
-|FOSSA Badge|
+   <!-- ## 特别的鸣谢
+
+   我们很乐意在下面列出对IamAI的发展方向和动机有着[重大贡献](https://academic.jyunko.cn/2023/04/04/April-Fours-Day.html)的组织和个人。如果你认为你应该在这里，请至少要像Bryan不可思议那样在文章底栏留言或者发送邮件联系我们 :D
+
+   个人: [A60](https://github.com/djkcyl)、[Bryan不可思议](https://github.com/ProgramRipper)
+   组织: [GariaProject](https://github.com/GraiaProject)
+
+   如果没有以上个人和组织的帮助，IamAI将不会有现在的样子。我们真的很感谢他们。 -->
+
+.. raw:: html
+
+   <hr />
+
+`MIT <https://github.com/retrofor/iamai/blob/main/LICENSE>`__ ©
+2023-PRESENT `Retro for Wut? <https://github.com/retrofor>`__.
+
+|FOSSA Status|
 
-.. _`Hugging Face`: https://huggingface.co
-.. _`transformers`: https://github.com/huggingface/transformers
-.. _`st`: https://github.com/st1020
-.. _`alicebot`: https://github.com/AliceBotProject/alicebot
-.. _`credits.pdf`: ./docs/_static/assets/credits.pdf
-.. _`MIT`: https://github.com/retrofor/iamai/blob/master/COPYING
-.. _`Retro for Wut?`: https://github.com/retrofor
 .. |FOSSA Status| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fretrofor%2Fiamai.svg?type=shield
    :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fretrofor%2Fiamai?ref=badge_shield
-.. |FOSSA Badge| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fretrofor%2Fiamai.svg?type=large
-   :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fretrofor%2Fiamai?ref=badge_large
-.. |docs| image:: https://readthedocs.org/projects/iamai/badge/?version=latest
-   :target: https://iamai.is-a.dev/en/latest/?badge=latest