Bladeren bron

Merge pull request #130 from zilliztech/read-me

Update Read me
ryjiang 2 jaren geleden
bovenliggende
commit
6ef3349928

BIN
.github/images/create_collection.png


BIN
.github/images/create_index.png


BIN
.github/images/data_preview.png


BIN
.github/images/query_advanced_filter.png


BIN
.github/images/system_view.png


BIN
.github/images/vector_search.png


+ 48 - 33
README.md

@@ -4,47 +4,50 @@
 [![downloads](https://img.shields.io/docker/pulls/zilliz/attu)](https://img.shields.io/docker/pulls/zilliz/attu)
 [![codecov](https://codecov.io/gh/zilliztech/attu/branch/main/graph/badge.svg?token=jvIEVF9IwW)](https://codecov.io/gh/zilliztech/attu)
 
-Attu provides an intuitive and efficient GUI for Milvus, allowing you to interact with your databases and manage your data with just few clicks.
+Attu is an all-in-one milvus administration tool. With Attu, you can dramatically reduce the cost of managing milvus.
 
-<img src="./.github/images/screenshot.png" alt="attu" />
+<img src="./.github/images/screenshot.png" alt="attu" width="800" alt="attu" />
 
-## Attu Doc
-
-- [English](./doc/en.md)
-- [中文](./doc/zh-cn.md)
-
-## Features and Roadmap
-
-Attu is under rapid development and we are adding new features weekly, here are the current plan, we will release a version once a feature is available.
+## Features
 
+- Basic dashboard
+  - View basic collection statistics
+  - Quick search from loaded collection
+  - Quick release loaded collection
 - Manage collections/partitions
-- Manage index
-- Basic statistics overview
-- Load/release collections for search
-- Insert entities
-- Vector search with advanced filter
+  - Create collection/partion
+  - Delete collection/partions
+  - View collection schema
+  - Create/drop index with parameters
+  - Load/release collections for search
+- Data Management
+  - Insert entities
+  - Data preview
+  - Data query
+- Vector search/query with advanced filter
 - System view
-- Data query
-- View root node configuration
-- Support TLS connection and username,password
-- Vector Visualization(TBD)
-- More...
+  - View milvus nodes system info
+  - View milvus nodes configuration
+- Manage Milvus user
+- More are comming...
 
 ## Quick start
 
-### Before you start
+> If you prefer desktop application, you can download the [desktop version of Attu](https://github.com/zilliztech/attu/releases/).
 
-Ensure you have Milvus installed on [your server](https://milvus.io/docs/install_standalone-docker.md) or [cluster](https://milvus.io/docs/install_cluster-docker.md), and attu only supports Milvus 2.x.
+## Run attu from docker
 
-### ⭐️ Start a attu instance
+> Ensure you have Milvus installed on [your server](https://milvus.io/docs/install_standalone-docker.md) or [cluster](https://milvus.io/docs/install_cluster-docker.md), and attu only supports Milvus 2.x.
 
-**_ Before attu v2.1.0 , [check here](https://github.com/zilliztech/attu/tree/v2.0.5) _**
+> _ Before attu v2.1.0 , [check here](https://github.com/zilliztech/attu/tree/v2.0.5) _\*\*
+
+### ✈️ Start a attu container
 
 ```code
 docker run -p 8000:3000 -e MILVUS_URL={milvus server ip}:19530 zilliz/attu:latest
 ```
 
-Once you start the docker, open the browser, type `http://{ attu ip }:8000`, you can view the attu.
+Once you start the container, open the browser, type `http://{ attu ip }:8000`, you can view the attu GUI.
 
 #### Params
 
@@ -54,15 +57,24 @@ Once you start the docker, open the browser, type `http://{ attu ip }:8000`, you
 
 Tip: **127.0.0.1 or localhost will not work when runs on docker**
 
-#### Try the dev build
+## Try the dev build
 
-**_note_** We plan to release attu once a feature is done. Also, if you want to try the nightly build, please pull the docker image with the `dev` tag.
+> We plan to release attu once a feature is done. Also, if you want to try the nightly build, please pull the docker image with the `dev` tag.
 
 ```code
 docker run -p 8000:3000 -e MILVUS_URL={ your machine IP }:19530 zilliz/attu:dev
 ```
 
-## ✨ Building and Running attu, and/or Contributing Code
+## Screenshots
+
+<img src="./.github/images/screenshot.png" alt="attu" width="800" alt="attu" />
+<img src="./.github/images/create_collection.png" width="800" alt="attu" />
+<img src="./.github/images/create_index.png" width="800" alt="attu" />
+<img src="./.github/images/data_preview.png" width="800" alt="attu" />
+<img src="./.github/images/query_advanced_filter.png" width="800" alt="attu" />
+<img src="./.github/images/vector_search.png" width="800" alt="attu" />
+
+## ✨ Contributing Code
 
 You might want to build Attu locally to contribute some code, test out the latest features, or try
 out an open PR:
@@ -83,20 +95,23 @@ out an open PR:
 
 ### Milvus
 
-New to milvus? Milvus is an open-source vector database built to power AI applications and embedding similarity search.
+New to milvus? [Milvus](https://milvus.io) is an open-source vector database built to power AI applications and embedding similarity search.
 
 ### Userful links
 
-- [Milvus installation guide](https://milvus.io/docs/v2.0.0/install_standalone-docker.md)
-- [Milvus python sdk](https://milvus.io/docs/v2.0.0/explore_pymilvus.md)
-- [Milvus bootcamp](https://milvus.io/bootcamp)
+- [Milvus docs](https://milvus.io/docs)
+- [Milvus python sdk](https://github.com/milvus-io/pymilvus)
+- [Milvus java sdk](https://github.com/milvus-io/milvus-sdk-java)
+- [Milvus gp sdk](https://github.com/milvus-io/milvus-sdk-go)
+- [Milvus node sdk](https://github.com/milvus-io/milvus-sdk-node)
+- [Feder](https://github.com/zilliztech/feder)
 
 #### ❓ Questions? Problems?
 
 - If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/zilliztech/attu/issues/new/choose).
   Please check to make sure someone else hasn't already created an issue for the same topic.
 
-[milvus-doc]: https://milvus.io/docs/home
+[milvus-doc]: https://milvus.io/docs
 
 ## Community