docs: japanese version (#34)

fakegit · Mar 26, 2019 · 0c32b86 · 0c32b86
1 parent 8fe0009
commit 0c32b86
Show file tree

Hide file tree

Showing 3 changed files with 148 additions and 13 deletions.
diff --git a/README-ja_JP.md b/README-ja_JP.md
@@ -0,0 +1,135 @@
+<h1 align="center">
+  <img src="https://zhstatic.zhihu.com/cfe/griffith/griffith-banner.png" height="200" width="200"/>
+  <p align="center" style="font-size: 0.5em">React に基づいたビデオプレイヤー</p>
+</h1>
+
+[![License](https://img.shields.io/npm/l/griffith.svg)](https://github.com/zhihu/griffith/blob/master/LICENSE)
+[![npm package](https://img.shields.io/npm/v/griffith/latest.svg)](https://www.npmjs.com/package/griffith)
+[![Build Status](https://img.shields.io/travis/zhihu/griffith.svg)](https://travis-ci.org/zhihu/griffith)
+[![codecov](https://codecov.io/gh/zhihu/griffith/branch/master/graph/badge.svg)](https://codecov.io/gh/zhihu/griffith)
+![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/zhihu/griffith/blob/master/CONTRIBUTING.md)
+
+[English](./README.md) | [简体中文](./README-zh_CN.md) | [日本語](./README-ja_JP.md)
+
+# はじめに
+
+<p align="center">
+  <img src="https://zhstatic.zhihu.com/cfe/griffith/player.png"/>
+</p>
+
+- **ストリーミング:** Griffith はストリーミングを簡単にします。ビデオフォーマットは mp4 や hls にかかわらず、Griffith は Media Source Extension (MSE) を使ってセグメントをロードすることができます。
+- **拡張性:** Griffith は React アプリにビデオ機能をサポートすることを簡単にします。React に基づいていない場合は、ブラウザで直接使用するための UMD（Universal Module Definition）もサポートされています。
+- **信頼性:** Griffith は Zhihu の Web およびモバイル Web で広く使用されています。
+
+## 使い方
+
+### React アプリ
+
+```bash
+yarn add griffith
+```
+
+```js
+import Player from 'griffith'
+
+const sources = {
+  hd: {
+    play_url: 'https://zhstatic.zhihu.com/cfe/griffith/zhihu2018_hd.mp4',
+  },
+  sd: {
+    play_url: 'https://zhstatic.zhihu.com/cfe/griffith/zhihu2018_sd.mp4',
+  },
+}
+
+render(<Player sources={sources} />)
+```
+
+[詳しく](./packages/griffith/README.md)
+
+**ノート: Griffith は SSR アプリを対応できません**
+
+### React に基づいていない場合
+
+```html
+<script src="https://unpkg.com/griffith-standalone/dist/index.umd.min.js" /></script>
+```
+
+```js
+const sources = {
+  hd: {
+    play_url: 'https://zhstatic.zhihu.com/cfe/griffith/zhihu2018_hd.mp4',
+  },
+  sd: {
+    play_url: 'https://zhstatic.zhihu.com/cfe/griffith/zhihu2018_sd.mp4',
+  },
+}
+
+Griffith.createPlayer(element).render({sources})
+```
+
+[スタンドアロンモードの詳しい使い方](./packages/griffith-standalone/README.md)
+
+## プロジェクトの構造
+
+Griffith は [Yarn workspace](https://yarnpkg.com/lang/en/docs/workspaces/) と [Lerna](https://github.com/lerna/lerna) を使っている Monorepo です。
+
+### コーア
+
+- `packages/griffith`: コーアライブラリ
+
+### ユーティリティ
+
+- `packages/griffith-message`: クロスドメイン通信のヘルパー
+- `packages/griffith-utils`: 他のユーティリティ
+
+### プラグイン
+
+- `packages/griffith-mp4`: MP4 プラグインは [MediaSource API](https://developer.mozilla.org/en-US/docs/Web/API/MediaSource) を使っています。
+- `packages/griffith-hls`: [HLS](https://developer.apple.com/streaming/) プラグインは [hls.js](https://github.com/video-dev/hls.js) を使っています。
+
+### その他
+
+- `example`: サンプル例とデモ
+- `packages/griffith-standalone`: 全部のモジュールを含めての UMD バージョン、ブラウザーで直接に使用できます。
+
+## カスタムビルド
+
+webpack のようなビルドツールはデフォルトで `griffith-mp4` と `packages/griffith-hls` を含みます。ビルド時に環境値を設定して、プラグインを除外することで、バンドルを小さくすることができます。
+
+webpack を使いる場合, [DefinePlugin](https://webpack.js.org/plugins/define-plugin/) が使えます。
+
+```javascript
+const {DefinePlugin} = require('webpack')
+
+module.exports = {
+  plugins: [
+    new DefinePlugin({
+      __WITHOUT_HLSJS__: JSON.stringify(true), // griffith-hls を抜く
+      __WITHOUT_MP4__: JSON.stringify(true), // griffith-mp4 を抜く
+    }),
+  ],
+}
+```
+
+要注意：`griffith-mp4` と `griffith-hls` がないと、ブラウザがネイティブにサポートしている限り、Griffith は MP4 と HLS メディアを再生できなくなります。
+
+## 貢献
+
+下記のとおり、Griffith への貢献はどんなものでも歓迎です。
+
+### 貢献ガイド
+
+[貢献ガイド](./CONTRIBUTING.md)を読んて、開発プロセスに参加します。
+
+### 貢献者一覧
+
+- [Cheng Wang](https://github.com/wangcheng678)
+- [Wuhao Liu](https://github.com/liuwuhaoo)
+- [Xiaoyan Li](https://github.com/lixiaoyan)
+- [Tianxiao Wang](https://github.com/xiaoyuhen)
+- [Xiaoshuang Bai (Designer)](https://www.behance.net/shawnpai)
+
+## ライセンス
+
+MIT
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -1,6 +1,6 @@
 <h1 align="center">
   <img src="https://zhstatic.zhihu.com/cfe/griffith/griffith-banner.png" height="200" width="200"/>
-  <p align="center" style="font-size: 0.5em">知乎视频播放器</p>
+  <p align="center" style="font-size: 0.5em">基于 React 的 Web 视频播放器</p>
 </h1>
 
 [![License](https://img.shields.io/npm/l/griffith.svg)](https://github.com/zhihu/griffith/blob/master/LICENSE)
@@ -10,15 +10,15 @@
 ![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/zhihu/griffith/blob/master/CONTRIBUTING.md)
 
-[English](./README.md) | 简体中文
+[English](./README.md) | [简体中文](./README-zh_CN.md) | [日本語](./README-ja_JP.md)
 
 ## 简介
 
 <p align="center">
   <img src="https://zhstatic.zhihu.com/cfe/griffith/player.png"/>
 </p>
 
-- **流式播放:** Griffith 让流式播放变得简单。无论你视频格式是 mp4 还是 hls，Griffith 都能使用媒体源拓展（MSE）来实现分段加载等功能。
+- **流式播放:** Griffith 让流式播放变得简单。无论你的视频格式是 mp4 还是 hls，Griffith 都能使用媒体源拓展（MSE）来实现分段加载等功能。
 - **可扩展性:** Griffith 让 React 应用接入视频播放功能变得简单。如果你的应用不基于 React，Griffith 还提供支持 standalone 模式可以免构建工具直接在浏览器中使用。
 - **可靠性:** Griffith 已经大范围应用知乎的桌面和移动 web 应用中。
 
@@ -72,7 +72,7 @@ Griffith.createPlayer(element).render({sources})
 
 ## 项目结构
 
-Griffith 是一个 monorepo，使用了 [Yarn workspace](https://yarnpkg.com/lang/en/docs/workspaces/) 和 [Lerna](https://github.com/lerna/lerna) 进行管理。
+Griffith 是一个 Monorepo，使用了 [Yarn workspace](https://yarnpkg.com/lang/en/docs/workspaces/) 和 [Lerna](https://github.com/lerna/lerna) 进行管理。
 
 ### 核心
 
@@ -124,11 +124,11 @@ module.exports = {
 
 ### 贡献者
 
-- Cheng Wang
-- Wuhao Liu
-- Xiaoyan Li
-- Tianxiao Wang
-- Xiaoshuang Bai (Designer)
+- [Cheng Wang](https://github.com/wangcheng678)
+- [Wuhao Liu](https://github.com/liuwuhaoo)
+- [Xiaoyan Li](https://github.com/lixiaoyan)
+- [Tianxiao Wang](https://github.com/xiaoyuhen)
+- [Xiaoshuang Bai (Designer)](https://www.behance.net/shawnpai)
 
 ## 版权许可证
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <h1 align="center">
   <img src="https://zhstatic.zhihu.com/cfe/griffith/griffith-banner.png" height="200" width="200"/>
-  <p align="center" style="font-size: 0.5em">A React-based web video player</p>
+  <p align="center" style="font-size: 0.5em">A React-based Web video player</p>
 </h1>
 
 [![License](https://img.shields.io/npm/l/griffith.svg)](https://github.com/zhihu/griffith/blob/master/LICENSE)
@@ -10,7 +10,7 @@
 ![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/zhihu/griffith/blob/master/CONTRIBUTING.md)
 
-English | [简体中文](./README-zh_CN.md)
+[English](./README.md) | [简体中文](./README-zh_CN.md) | [日本語](./README-ja_JP.md)
 
 # Introduction
 
@@ -72,7 +72,7 @@ Griffith.createPlayer(element).render({sources})
 
 ## Project Structure
 
-Griffith is a monorepo and uses [Yarn workspace](https://yarnpkg.com/lang/en/docs/workspaces/) and [Lerna](https://github.com/lerna/lerna).
+Griffith is a Monorepo and uses [Yarn workspace](https://yarnpkg.com/lang/en/docs/workspaces/) and [Lerna](https://github.com/lerna/lerna).
 
 ### Core
 
@@ -118,7 +118,7 @@ Note that without `griffith-mp4` / `griffith-hls` Griffith can no longer play MP
 
 Read below to learn how you can take part in improving Griffith.
 
-### [Contributing Guide](./CONTRIBUTING.md)
+### Contributing Guide
 
 Read our [contributing guide](./CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Griffith.