Skip to content

Commit fb202bf

Browse files
committed
docs: update README.md
1 parent 150985a commit fb202bf

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,51 @@
1-
# cli
1+
# Instill CLI <!-- omit in toc -->
2+
3+
[![Tests](https://github.com/instill-ai/cli/actions/workflows/go.yml/badge.svg?branch=main&event=push)](https://github.com/instill-ai/cli/actions/workflows/go.yml)
4+
[![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/release/instill-ai/cli.svg?include_prereleases&label=Release&color=lightblue)](https://github.com/instill-ai/cli/releases/latest)
5+
[![License](https://img.shields.io/github/license/instill-ai/cli.svg?color=lightblue&label=License)](./License.md)
6+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-lightblue.svg)](.github/code_of_conduct.md)
7+
8+
`instill` is the command line interface for **Instill Cloud**.
9+
10+
<a href="https://openapi.instill.tech" title="OpenAPI docs">
11+
<img src="https://dabuttonfactory.com/button.png?t=OpenAPI+docs&f=Open+Sans-Bold&ts=78&tc=000&hp=90&vp=80&c=round&bgt=unicolored&bgc=a0cfba" align="right" height="30">
12+
</a>
13+
14+
<a href="https://docs.instill.tech" title="User manual">
15+
<img src="https://dabuttonfactory.com/button.png?t=User+manual&f=Open+Sans-Bold&ts=78&tc=000&hp=90&vp=80&c=round&bgt=unicolored&bgc=a0cfba" align="right" height="30">
16+
</a>
17+
18+
## Table of contents <!-- omit in toc -->
19+
- [What is Instill Cloud?](#what-is-instill-cloud)
20+
- [Installation](#installation)
21+
- [Issues and discussions](#issues-and-discussions)
22+
23+
## What is Instill Cloud?
24+
25+
Instill AI is on a mission to make Vision AI accessible to everyone. With **Instill Cloud**, one can easily build up a data pipeline to transform unstructured visual data to structured data, starting to tap on the value of visual data.
26+
27+
**Instill Cloud** provides a **Pipeline** consisting of **Data Connector**, **Visual Data Operator** and **Logic Operator** components, to process unstructured visual data to their structured representation.
28+
29+
## Installation
30+
31+
### macOS <!-- omit in toc -->
32+
33+
`instill` is available via [Homebrew][] and as a downloadable binary from the [releases page][].
34+
35+
#### Homebrew <!-- omit in toc -->
36+
37+
To install:
38+
```
39+
brew install instill-ai/tap/instill
40+
```
41+
42+
To upgrade:
43+
```
44+
brew upgrade instill-ai/tap/instill
45+
```
46+
47+
## Issues and discussions
48+
Please directly report any issues in [Issues](https://github.com/instill-ai/cli/issues) or [Pull requests](https://github.com/instill-ai/cli/pulls), or raise a topic in [Discussions](https://github.com/instill-ai/cli/discussions).
49+
50+
[Homebrew]: https://brew.sh
51+
[releases page]: https://github.com/instill-ai/cli/releases/latest

0 commit comments

Comments
 (0)