From 32d894bdcab3bf8ac2a4343dc93cd1b709561180 Mon Sep 17 00:00:00 2001 From: Gary Date: Tue, 1 Oct 2024 02:57:10 -0400 Subject: [PATCH] chore: update README.md (#103) Because the original description is too simple, This commit: 1. aligns the introduction with the document, 2. adds a document section, 3. adds an API reference section. --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e93ab77..f248932 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,34 @@ [![Integration Test](https://github.com/instill-ai/artifact-backend/actions/workflows/integration-test.yml/badge.svg)](https://github.com/instill-ai/artifact-backend/actions/workflows/integration-test.yml) -`artifact-backend` manages all stateful resources for [Instill Core](https://github.com/instill-ai/instill-core). +💾 `Instill Artifact` orchestrates unstructured data to transform documents (e.g., HTML, PDF, CSV, PPTX, DOC), images (e.g., JPG, PNG, TIFF), audio (e.g., WAV, MP3 ) and video (e.g., MP4, MOV) into Instill Catalog - a unified AI-ready format. Instill Catalog is more than just a Knowledge Base; it is an Augmented Data Catalog for unstructured data and AI that ensures your data is clean, curated, and prepared for all of your future AI and Retrieval-Augmented Generation (RAG) needs. + +## Documentation + +Please refer to the [Instill Artifact Documentation](https://www.instill.tech/docs/artifact/introduction) for more details. + +## API Reference + +Please refer to the [Instill Artifact API Reference](https://openapi.instill.tech/reference/artifactpublicservice_listcatalogs) for more details. ## Contributing -Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details. +We welcome contributions from the community! Whether you're a developer, +designer, writer, or user, there are multiple ways to contribute: + +### Issue Guidelines + +We foster a friendly and inclusive environment for issue reporting. Before +creating an issue, check if it already exists. Use clear language and provide +reproducible steps for bugs. Accurately tag the issue (bug, improvement, +question, etc.). + +### Code Contributions + +Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for +more details. Your code-driven innovations are more than welcome! -## Community support +## Community Please refer to the [community](https://github.com/instill-ai/community) repository.