Browse Source

Merge remote-tracking branch 'upstream/main' into feature/insert-data

tumao 4 years ago
parent
commit
01ec207f2a
1 changed files with 23 additions and 5 deletions
  1. 23 5
      README.md

+ 23 - 5
README.md

@@ -4,8 +4,24 @@ Milvus insight provides an intuitive and efficient GUI for Milvus, allowing you
 
 
 <img src="./.github/images/screenshot.png" alt="Miluvs insight" />
 <img src="./.github/images/screenshot.png" alt="Miluvs insight" />
 
 
-## ⭐️ Install
-
+## Features
+- Manage collections/partitions
+- Manage index
+- Basic statistics overview
+- Load/release collections for search
+- Insert vectors(TBD)
+- Vector search with advanced filter(TBD)
+- Milvus cluster info topology view(TBD)
+- View milvus node configuration(TBD)
+- Data view (TBD)
+- more...
+
+## Quick start
+
+### Before you start
+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 Milvus insight only supports Milvus 2.x. 
+
+### ⭐️ Install Milvus insight
 Start Docker container and map the url to the container:
 Start Docker container and map the url to the container:
 
 
 ```code
 ```code
@@ -19,6 +35,7 @@ docker run -p 8000:3000 -e HOST_URL=http://127.0.0.1:8000 -e MILVUS_URL=127.0.0.
 
 
 Once you start the docker, open the browser, type `http://127.0.0.1:8000`, you can view the milvus insight.
 Once you start the docker, open the browser, type `http://127.0.0.1:8000`, you can view the milvus insight.
 
 
+
 ## ✨ Building and Running Milvus insight, and/or Contributing Code
 ## ✨ Building and Running Milvus insight, and/or Contributing Code
 
 
 You might want to build Milvus-insight locally to contribute some code, test out the latest features, or try
 You might want to build Milvus-insight locally to contribute some code, test out the latest features, or try
@@ -40,13 +57,14 @@ out an open PR:
 
 
 ### Milvus
 ### Milvus
 New to milvus? Milvus is an open-source vector database built to power AI applications and embedding similarity search.
 New to milvus? Milvus 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 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 python sdk](https://milvus.io/docs/v2.0.0/explore_pymilvus.md)
 - [Milvus bootcamp](https://milvus.io/bootcamp)
 - [Milvus bootcamp](https://milvus.io/bootcamp)
 
 
-## 📖 Documentation
 
 
-TBD
 
 
 ## Community
 ## Community
 
 
@@ -56,7 +74,7 @@ TBD
     <img src="https://zillizstorage.blob.core.windows.net/zilliz-assets/zilliz-assets/assets/readme_slack_4a07c4c92f.png" alt="Miluvs Slack Channel"  height="150" width="500">
     <img src="https://zillizstorage.blob.core.windows.net/zilliz-assets/zilliz-assets/assets/readme_slack_4a07c4c92f.png" alt="Miluvs Slack Channel"  height="150" width="500">
 </a>
 </a>
 
 
-### ❓ Questions? Problems?
+#### ❓ Questions? Problems?
 
 
 - If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/milvus-io/milvus-insight/issues/new/choose).
 - If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/milvus-io/milvus-insight/issues/new/choose).
   Please check to make sure someone else hasn't already created an issue for the same topic.
   Please check to make sure someone else hasn't already created an issue for the same topic.