textalive-app-api - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.9.2"
+      "packageVersion": "7.9.15"
     }
   ]
 }

package.json

 {
   "name": "textalive-app-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "dist/index.js",
@@ -21,2 +21,5 @@ "module": "dist/index.es.js",
   },
+  "optionalDependencies": {
+    "songle-api": "^1.2.2"
+  },
   "bugs": {
@@ -23,0 +26,0 @@ "url": "https://github.com/TextAliveJp/textalive-app-api/issues"

README.md

 # TextAlive App API
 
-![TextAlive](https://i.gyazo.com/thumb/1000/5301e6f642d255c5cfff98e049b6d1f3-png.png)
+TextAlive App API は、 **音楽に合わせてタイミングよく歌詞が動く Web アプリケーション（リリックアプリ）** を開発できる JavaScript 用のライブラリです。
 
----
+この API を使うと、Web 上の楽曲のサビやビートなどの楽曲地図情報を取得したり、Web 上の歌詞のタイミング情報を取得したりできるようになります。そして、一曲のために作り込んだ演出はもちろんのこと、 [TextAlive](https://textalive.jp/) に登録されている全ての楽曲に合わせて動作する演出をプログラミングできます。
 
-TextAlive App API を使って TextAlive アプリを開発するためのライブラリです。
+[![npm version](https://img.shields.io/npm/v/textalive-app-api)](https://www.npmjs.com/package/textalive-app-api)
 
+![TextAlive](https://i.gyazo.com/thumb/1000/5301e6f642d255c5cfff98e049b6d1f3-png.png)
+
 ## 使い方
 
-npm パッケージ `textalive-app-api` をインストールしてから、 `import { Player } from "textalive-app-api";` のように必要なコンポーネントをインポートして使います。
+TextAlive App API は `script` タグで Web サイトに読み込んだり、 npm パッケージ `textalive-app-api` をインストールすることで使えるようになります。
 
-`Player` クラスの説明は [こちら](https://developer.textalive.jp/packages/textalive-app-api/classes/player.html) にあります。
+ほとんどの機能のエントリーポイントになる `Player` クラスの説明は [こちら](https://developer.textalive.jp/packages/textalive-app-api/classes/player.html) にあります。
 
+### `script` タグによる読み込み
+
+```html
+<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
+<script src="https://unpkg.com/textalive-app-api/dist/index.js"></script>
+```
+
+グローバル変数 `TextAliveApp` が定義されるので、 `const { Player } = TextAliveApp;` のように必要なコンポーネントを呼び出して使います。
+
+### npm パッケージのインストール
+
+```sh
+npm install textalive-app-api
+```
+
+`import { Player } from "textalive-app-api";` のように必要なコンポーネントをインポートして使います。
+
 ## 開発者向けドキュメント
 
-詳しくは https://developer.textalive.jp/app をご覧ください。
+- [TextAlive App API チュートリアル](https://developer.textalive.jp/app)
+- [API リファレンス](https://developer.textalive.jp/packages/textalive-app-api)
+- [GitHub サンプルコード](https://github.com/TextAliveJp)
 
-- [TextAlive for Developers トップページ](https://developer.textalive.jp)
-- [`textalive-app-api` API リファレンス](https://developer.textalive.jp/packages/textalive-app-api)
+技術的に分からないことやバグ報告などがあれば、 [GitHub Issues](https://github.com/TextAliveJp/textalive-app-api/issues) までお願いいたします。
+[TextAlive for Developers トップページ](https://developer.textalive.jp) もぜひご覧ください。
 
@@ -22,0 +43,0 @@ ---

New alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

663722

increased by0.32%

Lines of code

6488

increased by0.03%

Number of lines in readme file

46

increased by84%

Worsened metrics

Dependency count

3

increased by50%

No dependency changes