add readme (#89)

add readme
2026-08-29 08:18:10 +08:00 · 2024-04-09 18:10:29 +08:00
parent 13d77c5b09
commit 55f72fd2e3
8 changed files with 158 additions and 1 deletions
@@ -0,0 +1,53 @@
+## Code of Conduct
+
+### Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+### Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+### Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team responsible for enforcement at [contact@cannerdata.com](mailto:contact@cannerdata.com). All complaints will be reviewed and investigated promptly and fairly.
+
+All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1,
+available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: https://www.contributor-covenant.org/version/2/1
@@ -1 +1,105 @@
-# WrenAI
+
+
+<p align="center">
+  <a href="https://getwren.ai">
+    <picture>
+      <source media="(prefers-color-scheme: light)" srcset="./misc/wrenai_logo.png">
+      <img src="./misc/wrenai_logo.png">
+    </picture>
+    <h1 align="center">WrenAI</h1>
+  </a>
+</p>
+
+<p align="center">
+  <a aria-label="Canner" href="https://cannerdata.com/">
+    <img src="https://img.shields.io/badge/%F0%9F%A7%A1-Made%20by%20Canner-blue?style=for-the-badge">
+  </a>
+  <a aria-label="Releases" href="https://github.com/canner/WrenAI/releases">
+    <img alt="" src="https://img.shields.io/github/v/release/canner/WrenAI?logo=github&label=GitHub%20Release&color=blue&style=for-the-badge">
+  </a>
+  <a aria-label="License" href="https://github.com/Canner/wrenai/blob/main/LICENSE">
+    <img alt="" src="https://img.shields.io/github/license/canner/wrenai?color=blue&style=for-the-badge">
+  </a>
+  <a aria-label="Join the community on GitHub" href="https://discord.gg/5DvshJqG8Z">
+    <img alt="" src="https://img.shields.io/badge/-JOIN%20THE%20COMMUNITY-blue?style=for-the-badge&logo=discord&logoColor=white&labelColor=grey&logoWidth=20">
+  </a>
+  <a aria-label="Follow us" href="https://x.com/getwrenai">
+    <img alt="" src="https://img.shields.io/badge/-@getwrenai-blue?style=for-the-badge&logo=x&logoColor=white&labelColor=gray&logoWidth=20">
+  </a>
+</p>
+
+
+> WrenAI is ***your AI data assistant*** that helps you get results and insights faster by asking questions without writing SQL.
+
+![wrenai_overview](./misc/wrenai_overview.png)
+
+## 🎯 Our Mission
+
+WrenAI is dedicated to reimagining how businesses can interact with and leverage their data through LLM, by bringing comprehension capabilities to small and large data teams.
+
+## 🤔 Benefits using WrenAI
+
+WrenAI leverages Large Language Models (LLM) with Retrieval-Augmented Generation (RAG) technology to enhance comprehension of internal data.  Below are the three key benefits:
+
+### 1. Fast Onboarding
+
+> Discover and analyze your data with our user interface. Effortlessly generate results without needing to code.
+
+### 2. Secure By Design
+
+> Your database contents will never be transmitted to the LLM. Only metadata, like schemas, documentation, and queries, will be used in semantic search.
+
+### 3. Open-Source
+
+> Deploy WrenAI anywhere you like on your own data, LLM APIs, and environment, it's free.
+
+## 🤖 WrenAI's Architecture
+
+WrenAI is consist of three core services:
+
+- ***Wren UI:*** An intuitive user interface for asking questions, defining data relationships, and integrating data sources within WrenAI's framework.
+
+- ***Wren AI Service:*** Processes queries using a vector database for context retrieval, guiding LLMs to produce precise SQL outputs.
+
+- ***Wren Engine:*** Serves as the platform's backbone, managing metadata and connecting to data sources, while preparing for future application integrations.
+
+![wrenai_works](./misc/how_wrenai_works.png)
+
+## 🫣 Sneak Peek
+
+|  Data Modeling   | Ask and Follow-up Questions  |
+|  ----  | ----  |
+| ![preview_model](./misc/preview_model.png)  | ![preview_ask](./misc/preview_ask.png) |
+
+## 🤞 Design Philosophies
+
+We have some core design philosophies that were used when developing WrenAI.
+
+- **Explainability**: WrenAI ensures that every SQL query generated in natural language is accurate, concise, and reliable.
+- **Interoperability**: WrenAI enables users to query data from multiple sources without dealing with the complexities of different data formats and dialects, providing a standard interface across different sources.
+- **Interactive Experience**: WrenAI is designed to engage users in a dialogue, clarifying their queries and refining results in real time.
+- **Continuous Learning**: WrenAI will proactively learn through ongoing query history, feedback, and interactions. Incorporating new patterns, information, and data structures into our LLM knowledge base.
+
+## 🚧 Project Status
+
+WrenAI is currently in ***alpha version***. The project team is actively working on progress and aiming to release new versions at least biweekly.
+
+## 🚀 Getting Started
+
+Using WrenAI is super simple, you can setup within 3 minutes, and start to interact with your own data!
+
+***Start Today And Be 100X More Productive Than Yesterday***
+
+- Visit our [Installation Guide of WrenAI](http://docs.getwren.ai/installation).
+- Visit the [Usage Guides](http://docs.getwren.ai/guide/connect/overview) to learn more about how to use WrenAI.
+
+## 📚 Documentation
+
+Visit [WrenAI documentation](https://docs.getwren.ai) to view the full documentation.
+
+## ⭐️ Community
+
+- Welcome to our [Discord server](https://discord.gg/5DvshJqG8Z) to give us feedback!
+- If there is any issues, please visit [Github Issues](https://github.com/Canner/WrenAI/issues).
+
+Do note that our [Code of Conduct](./CODE_OF_CONDUCT.md) applies to all WrenAI community channels. Users are **highly encouraged** to read and adhere to them to avoid repercussions.