Skip to content

Commit

Permalink
chore: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ContentsViewer committed May 13, 2024
1 parent b007e5c commit 84e2084
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It has the following features:
* As a PWA, it provides a similar user experience on many platforms (`Windows`, `macOS`, `iOS`, `Android`).
* It plays from centrally managed cloud storage, so there is no need to sync music for each player.
* Even offline, music that has been downloaded can be played.
* Even when the app is in the background, music can be played automatically (only on `iOS`, operation depends on Safari).
* Even when the app is in the background, music can be played sequentially (May not work on iOS only).
* The style and animation of the app change dynamically according to the music.

> [!WARNING]
Expand All @@ -39,3 +39,14 @@ It has the following features:
npm install
npm run dev
```

### Building the production version and verifying its operation

```sh
npm run build
npx serve@latest out
```

## Further information

* [Home Page](https://contentsviewer.work/Master/apps/cloud-music-box/docs)
6 changes: 5 additions & 1 deletion README_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Cloud Music Boxは、クラウドストレージ(現在は`OneDrive`のみ)か
* PWAとして、多くのプラットフォーム(`Windows`, `macOS`, `iOS`, `Android`)上で同様のユーザ体験を実現します。
* 一元管理されたクラウドストレージからの再生で、プレイヤーごとに音楽を同期する必要がありません。
* オフラインでも、ダウンロード済みの音楽は再生可能です。
* アプリがバックグラウンドにある場合でも、音楽の自動再生が可能です(`iOS`のみ動作がSafari依存)。
* アプリがバックグラウンドにある場合でも、音楽の連続再生が可能です(iOSのみ動作しないことがある)。
* 音楽に合わせて、動的にアプリのスタイルやアニメーションが変化します。

> [!WARNING]
Expand All @@ -46,3 +46,7 @@ npm run dev
npm run build
npx serve@latest out
```

## さらなる情報

* [Home Page](https://contentsviewer.work/Master/apps/cloud-music-box/docs)
2 changes: 1 addition & 1 deletion app/settings/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ export default function Page() {
>
<Link
variant="body2"
href="https://contentsviewer.work"
href="https://contentsviewer.work/Master/apps/cloud-music-box/docs"
target="_blank"
rel="noopener"
>
Expand Down

0 comments on commit 84e2084

Please sign in to comment.