From 597e128ded813efa7807d5b87dcca720f7ef63e1 Mon Sep 17 00:00:00 2001
From: Omochice <mochice.mls.ntl@gmail.com>
Date: Sun, 22 Oct 2023 19:09:07 +0900
Subject: [PATCH] docs: Add readme file

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b4c153
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# @Omochice/renovate-config
+
+[![basic ci](https://github.com/Omochice/renovate-config/actions/workflows/ci.yml/badge.svg)](https://github.com/Omochice/renovate-config/actions/workflows/ci.yml)
+
+A configuration for Renovate.
+
+## To use
+
+Extends this configuration using by `extends` field.
+
+```json
+{
+  "extends": [
+    "github>Omochice/renovate-config"
+  ]
+}
+```
+
+If you use Renovate in Deno project.
+
+```json
+{
+  "extends": [
+    "github>Omochice/renovate-config:deno"
+  ]
+}
+```
+
+## Limitation
+
+Currently, there are following limitions on Deno project:
+
+- Only support some datasources
+  - https://deno.land/std
+  - https://deno.land/x
+  - `npm:` specifier
+  - https://esm.sh
+  - See [test case](./test/deno.test.ts) for supported syntax
+- Dynamic import is not followed
+
+## License
+
+[zlib](./LICENSE)