Skip to content

Commit ceabc3a

Browse files
authored
home page badges & installation guide (#84)
* Add github to doc navbar * Don't autoplay the quick start video * git and discord badge * Update README.md * Update README.md * Update README.md * Update README.md * installation * polish readme and update installation with python/pip version and installation * Update installation.md * Update installation.md * Update README.md * Update README.md * Update README.md * Update installation.md * Update README.md * Update README.md * Update README.md * Update installation.md * Update installation.md
1 parent e846a28 commit ceabc3a

File tree

3 files changed

+45
-5
lines changed

3 files changed

+45
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@
44

55
<h2 align="center">Extract, Transform, Index Data. Easy and Fresh. 🌴</h2>
66

7+
<div align="center">
8+
9+
[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex)
710
[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0)
8-
[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/)
911
[![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/)
10-
[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml)
11-
[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml)
12-
[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml)
13-
[![Discord](https://img.shields.io/badge/discord-cocoindex-5B5BD6?logo=discord&logoColor=white)](https://discord.com/invite/zpA9S2DR7s)
12+
[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/)
13+
[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml)
14+
[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml)
15+
[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml)
16+
[![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s)
1417
[![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex)
1518
[![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io)
1619

20+
</div>
21+
1722
CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.
1823
<p align="center">
1924
<img src="https://cocoindex.io/images/venn.svg" alt="CocoIndex">
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Installation
3+
description: Setup the CocoIndex environment in 0-3 min
4+
---
5+
6+
## 🐍 Python and Pip
7+
To follow the steps in this guide, you'll need:
8+
9+
1. Install [Python](https://wiki.python.org/moin/BeginnersGuide/Download/). We support Python 3.11 to 3.13.
10+
2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer
11+
12+
13+
## 🌴 Install CocoIndex
14+
```bash
15+
pip install cocoindex
16+
```
17+
18+
## 📦 Install Postgres
19+
20+
You can skip this step if you already have a Postgres database with pgvector extension installed.
21+
22+
If you don't have a Postgres database:
23+
24+
1. Install [Docker Compose](https://docs.docker.com/compose/install/) 🐳.
25+
2. Start a Postgres SQL database for cocoindex using our docker compose config:
26+
27+
```bash
28+
docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/postgres.yaml) up -d
29+
```
30+
31+
## 🎉 All set!
32+
33+
You can now start using CocoIndex.
34+

docs/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ const sidebars: SidebarsConfig = {
99
items: [
1010
'getting_started/overview',
1111
'getting_started/quickstart',
12+
'getting_started/installation',
1213
],
1314
},
1415
{

0 commit comments

Comments
 (0)