@squadbase/connectors 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,37 @@
+# @squadbase/connectors
+
+Squadbase Connectors - データソースへの接続を提供するパッケージ。
+
+## セットアップ
+
+```bash
+npm install
+```
+
+### lockfile を再生成する場合
+
+devDependency の `@squadbase/dashboard-types` は GitHub Packages に公開されているため、lockfile を削除して再生成する場合はレジストリのフラグ指定が必要です。
+
+```bash
+rm package-lock.json
+npm install --@squadbase:registry=https://npm.pkg.github.com
+```
+
+lockfile が存在する場合は `resolved` URL が記録されているため、通常の `npm install` で問題ありません。
+
+## ビルド
+
+```bash
+npm run build
+```
+
+## npm への公開
+
+```bash
+npm run build
+npm publish
+```
+
+## コネクターの追加・管理
+
+詳細は [docs/connector.md](docs/connector.md) を参照してください。