-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from wey-gu/dev
docs: update readme
- Loading branch information
Showing
1 changed file
with
35 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,35 @@ | ||
# nebulagraph-lite | ||
# NebulaGraph Lite | ||
|
||
[![for NebulaGraph](https://img.shields.io/badge/Toolchain-NebulaGraph-blue)](https://github.com/vesoft-inc/nebula) | ||
[![Jupyter](https://img.shields.io/badge/Jupyter-Supported-brightgreen)](https://github.com/jupyterlab/jupyterlab) | ||
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/wey-gu/nebulagraph-lite?label=Version)](https://github.com/wey-gu/nebulagraph-lite/releases) | ||
[![pypi-version](https://img.shields.io/pypi/v/nebulagraph-lite)](https://pypi.org/project/nebulagraph-lite/) | ||
[![python-version](https://img.shields.io/badge/python-3.6.2%20|%203.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-blue)](https://www.python.org/) | ||
|
||
Try NebulaGraph with `pip install`. | ||
|
||
## How to use | ||
|
||
> Install NebulaGraph Lite | ||
```bash | ||
pip3 install nebulagraph-lite | ||
``` | ||
|
||
> Start NebulaGraph Lite from Jupyter Notebook | ||
```python | ||
from nebulagraph_lite import nebulagraph_let as ng_let | ||
|
||
n = ng_let() | ||
|
||
n.start() | ||
``` | ||
|
||
## What's next | ||
|
||
Play with `nebula3-python` or [ipython-ngql](https://github.com/wey-gu/ipython-ngql). | ||
|
||
```bash | ||
pip3 install ipython-ngql | ||
``` |