diff --git a/README.md b/README.md index 9cd751021..dc5e1ce6b 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,21 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

+
+ +[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) -[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) -[![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) -[![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) -[![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) -[![Discord](https://img.shields.io/badge/discord-cocoindex-5B5BD6?logo=discord&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) +[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) +[![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) +[![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) +[![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) +[![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +
+ CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.

CocoIndex diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md new file mode 100644 index 000000000..e2854288a --- /dev/null +++ b/docs/docs/getting_started/installation.md @@ -0,0 +1,34 @@ +--- +title: Installation +description: Setup the CocoIndex environment in 0-3 min +--- + +## 🐍 Python and Pip +To follow the steps in this guide, you'll need: + +1. Install [Python](https://wiki.python.org/moin/BeginnersGuide/Download/). We support Python 3.11 to 3.13. +2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer + + +## 🌴 Install CocoIndex +```bash +pip install cocoindex +``` + +## 📦 Install Postgres + +You can skip this step if you already have a Postgres database with pgvector extension installed. + +If you don't have a Postgres database: + +1. Install [Docker Compose](https://docs.docker.com/compose/install/) 🐳. +2. Start a Postgres SQL database for cocoindex using our docker compose config: + +```bash +docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/postgres.yaml) up -d +``` + +## 🎉 All set! + +You can now start using CocoIndex. + diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 7ea953e57..489433e70 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -9,6 +9,7 @@ const sidebars: SidebarsConfig = { items: [ 'getting_started/overview', 'getting_started/quickstart', + 'getting_started/installation', ], }, {