Skip to content

Commit

Permalink
chore(readme): update README content
Browse files Browse the repository at this point in the history
  • Loading branch information
kuroxx committed Sep 17, 2024
1 parent 5178a39 commit 2dd3cf1
Showing 1 changed file with 18 additions and 28 deletions.
46 changes: 18 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,26 @@

- [**💾 Instill Artifact**](https://www.instill.tech/docs/artifact/introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Data orchestration to transform unstructured data into AI-ready format
- [**💧 Instill VDP**](https://www.instill.tech/docs/vdp/introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Pipeline orchestration to address unstructured data ETL challenges
- [**⚗️ Instill Model**](https://www.instill.tech/docs/model/introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Model orchestration for MLOps/LLMOps.
- [**⚗️ Instill Model**](https://www.instill.tech/docs/model/introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Model orchestration for MLOps/LLMOps


See the [Documentation](https://www.instill.tech/docs/latest/core/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme).
See the [Documentation](https://www.instill.tech/docs/welcome/?utm_source=github&utm_medium=readme&utm_campaign=org_readme).


## Quick Start

There are a few ways to get started:

### ☁️ Instill Cloud (public cloud)

**[Instill Cloud](https://instill.tech/?utm_source=github&utm_medium=readme&utm_campaign=instill-core)** is a fully managed public cloud service, providing you with access to all the features of **Instill Core** without the burden of infrastructure management. All you need to do is to one-click sign up to start building your AI-first applications.
**[Instill Cloud](https://instill.tech/?utm_source=github&utm_medium=readme&utm_campaign=instill-core)** is a fully managed public cloud service that offers all features of **Instill Core** without infrastructure hassles.

To get started, simply [sign up here](https://instill.tech/?utm_source=github&utm_medium=readme&utm_campaign=instill-core) with one click to start building AI-first applications instantly or follow the [Quickstart Guide](https://www.instill.tech/docs/quickstart#%EF%B8%8F-instill-cloud?utm_source=github&utm_medium=readme&utm_campaign=instill-core).

See the [Quickstart Guide](https://www.instill.tech/docs/quickstart#%EF%B8%8F-instill-cloud?utm_source=github&utm_medium=readme&utm_campaign=instill-core).

### 🔮 Instill Core (self-hosting)
### 🔮 Instill Core (self-host)

**Prerequisites**
#### Prerequisites

| Operating System | Requirements and Instructions |
|------------------|--------------------------------|
Expand All @@ -52,11 +55,10 @@ See the [Quickstart Guide](https://www.instill.tech/docs/quickstart#%EF%B8%8F-in

<!-- x-release-please-start-version -->
```bash
git clone -b v0.40.1-beta https://github.com/instill-ai/instill-core.git
cd instill-core
$ git clone -b v0.40.1-beta https://github.com/instill-ai/instill-core.git && cd instill-core

# Launch all services
make all
$ make all
```
<!-- x-release-please-end -->

Expand All @@ -68,11 +70,10 @@ See the [Quickstart Guide](https://www.instill.tech/docs/quickstart#%EF%B8%8F-in
Execute these commands to build images with all dependencies:

```bash
git clone https://github.com/instill-ai/instill-core.git
cd instill-core
$ git clone https://github.com/instill-ai/instill-core.git && cd instill-core
# Launch all services
make latest PROFILE=all
$ make latest PROFILE=all
```

> [!IMPORTANT]
Expand All @@ -81,28 +82,17 @@ See the [Quickstart Guide](https://www.instill.tech/docs/quickstart#%EF%B8%8F-in
#### Getting Started

Once all services are up with health status:
- Access the UI at http://localhost:3000
- Find default login credentials in the [documentation](https://www.instill.tech/docs/latest/quickstart#self-hosted-instill-core)
- Access the UI at http://localhost:3000
- Find default login credentials in the [documentation](https://www.instill.tech/docs/latest/quickstart#self-hosted-instill-core)

To shut down all running services:
```bash
make down
```
$ make down
```

For more deployment options, see our [documentation](https://www.instill.tech/docs/latest/core/deployment).


## Client Access

To access **🔮 Instill Core** and **☁️ Instill Cloud**, you have a few options:
- <b>📺 <a href="https://github.com/instill-ai/console" target="_blank">Instill Console</a></b>
- <b>⌨️ <a href="https://github.com/instill-ai/cli" target="_blank">Instill CLI</a></b>
- <b>📦 Instill SDK</b>:
- [Python SDK](https://github.com/instill-ai/python-sdk)
- [TypeScript SDK](https://github.com/instill-ai/typescript-sdk)
- Stay tuned, as more SDKs are on the way!


## 📖 Documentation & Guides

For comprehensive documentation, please visit our [official documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core).
Expand All @@ -120,7 +110,7 @@ We enthusiastically welcome contributions from our community! Whether you're a d
1. **Cookbooks**: Help us create helpful pipelines and guides for the community. Visit our [Cookbook repository](https://github.com/instill-ai/cookbook) to get started.
2. **Issues**: Contribute to improvements by raising tickets using [templates here](https://github.com/instill-ai/instill-core/issues/new/choose) or discuss in existing ones you think you can helpwith.
2. **Issues**: Contribute to improvements by raising tickets using [templates here](https://github.com/instill-ai/instill-core/issues/new/choose) or discuss in existing ones you think you can help with.
### Community Standards
Expand Down

0 comments on commit 2dd3cf1

Please sign in to comment.