Skip to content

Commit

Permalink
chore: update README.md (#103)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Yougigun authored Oct 1, 2024
1 parent feab1e8 commit 32d894b
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 32d894b

Please sign in to comment.