Skip to content

Commit 772e02f

Browse files
authored
Add deprecation notice
1 parent 0d91448 commit 772e02f

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# db-connect
1+
# ~~db-connect~~
22

3-
### This is an experimental project and does not have official support yet.
3+
### :warning: This was an experimental project and is [not supported.](https://github.com/cloudflare/db-connect/issues/10)
44

5-
Connect your SQL database to [Cloudflare Workers](https://workers.cloudflare.com/). Import this lightweight Javascript library to execute commands or cache queries from a database through an [Argo Tunnel](https://developers.cloudflare.com/argo-tunnel/quickstart/). Although designed for Workers, this library can be used in any environment that has access to the [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax) and [SubtleCrypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#Syntax) APIs.
5+
Connect your SQL database to [Cloudflare Workers](https://workers.cloudflare.com/). Import this lightweight Javascript library to execute commands or cache queries from a database through an [Argo Tunnel](https://github.com/cloudflare/cloudflared/releases/tag/2021.2.2). Although designed for Workers, this library can be used in any environment that has access to the [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax) and [SubtleCrypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#Syntax) APIs.
66

77
# Installation
88

@@ -62,8 +62,6 @@ db-connect-quickstart
6262
* [Clickhouse](https://github.com/kshvakov/clickhouse)
6363
* [SQLite3](https://github.com/mattn/go-sqlite3)
6464

65-
In the future, we may consider adding support for more databases such as Oracle, MongoDB, and Redis. If you want to contribute you can track the code in the [`cloudflared`](https://github.com/cloudflare/cloudflared/tree/master/dbconnect) repository.
66-
6765
# Documentation
6866

6967
## `new DbConnect(options)`
@@ -137,7 +135,3 @@ If you want to test `db-connect` without a database you can use the following co
137135
```bash
138136
cloudflared db-connect --playground
139137
```
140-
141-
# Beta Access
142-
143-
We are looking for beta testers who want to create applications using `db-connect` using Cloudflare Workers. If you have a use-case or an idea, [reach out](mailto:[email protected]) to us and we'll consider giving you with special access!

0 commit comments

Comments
 (0)