From b08552c83a7ea56ff87601b6dbadecb59dc3e7b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Vall=C3=A9s?= Date: Mon, 30 Sep 2024 18:11:09 +0200 Subject: [PATCH] chore(docs): Update README with deprecation note --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 828d2789..2232f0cf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ # Component +--- + +## ⚠️ Deprecation of this repository + +This repository is in process of being moved to +[`pipeline-backend`](https://github.com/instill-ai/pipeline-backend/tree/main/pkg/component). +Please, update and import the code in / from that repository instead of this +one. + +A few remaining tasks remain before archiving the repository: +- [ ] Port the Pull Requests to `pipeline-backend`. +- [ ] Move [`compogen`](./tools/compogen) to `pipeline-backend`. +- [ ] Merge the contribution guidelines in the new repository. + +--- + A **component** is the basic building block of the [**Instill Core**](https://github.com/instill-ai/instill-core) pipeline. The pipeline consists of multiple components. We have two types of components: connectors and operators. This Golang package defines the common interface and functions for all components.