Skip to content

Commit a6adfa8

Browse files
committed
增加README.md说明,主要配置说明
1 parent 70e7a18 commit a6adfa8

1 file changed

Lines changed: 51 additions & 16 deletions

File tree

README.md

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,61 @@
1-
# Wild-ember
1+
# wildember简介
22

3-
This README outlines the details of collaborating on this Ember addon.
3+
wildember是一个方便、快捷连接野狗实时服务适配器。
44

5-
## Installation
5+
[wildemer](https://github.com/ubuntuvim/wildemer)是一个类似[Emberfire](https://github.com/firebase/emberfire)的适配器,
6+
不同的是前者用于适配[野狗](https://www.wilddog.com/)实时服务,
7+
后者用于适配[firebase](https://www.firebase.com/)实时服务。
68

7-
* `git clone` this repository
8-
* `npm install`
9-
* `bower install`
109

11-
## Running
10+
野狗和firebase都是实时的数据服务,但是遗憾的是firebase是谷歌的,你懂的在天朝想访问都是比较那个啥的!!!
11+
所以找了国内的替代品——野狗。当然不是时候野狗不好,如果你使用过这两个服务就会发现其实野狗就是firebase(说难听其实就是直接抄firebase的,连API、调用方法都一样!!)。
12+
也正是因为firebase无法访问所以我们为Ember.js的开发提供了连接野狗的适配器wildemer。它的使用方式和firebase一模一样,因为WildEmber是直接fork Emberfire的(说难听点其实也是抄Emberfire的!!)。
1213

13-
* `ember server`
14-
* Visit your app at http://localhost:4200.
1514

16-
## Running Tests
15+
## 安装wildember
1716

18-
* `npm test` (Runs `ember try:testall` to test your addon against multiple Ember versions)
19-
* `ember test`
20-
* `ember test --server`
17+
* 使用命令安装:`npm install wildember`
18+
* 修改`app/adapters/application.js`
19+
在文件内增加如下代码:
20+
```js
21+
wilddogConfig: {
22+
syncDomain: "<appId>.wilddog.com",
23+
syncURL: "https://<appId>.wilddogio.com" //输入节点 URL
24+
}
25+
```
26+
代码中的`<appId>`是你在野狗创建的应用id。可以在[https://www.wilddog.com/dashboard/](https://www.wilddog.com/dashboard/),如下图所示:
2127

22-
## Building
28+
![appid](http://emberteach.ddlisting.com/content/images/2016/09/wilddog.png)
2329

24-
* `ember build`
30+
红色圈中的部分就是你的应用appid。详细例子请参考:[library-app的adapters/application.js](https://github.com/ubuntuvim/wildember/blob/master/tests/dummy/app/adapters/application.js)
2531

26-
For more information on using ember-cli, visit [http://ember-cli.com/](http://ember-cli.com/).
32+
* 导入wilddog,请在你的ember应用的`app/index.html`文件中导入野狗的库文件。
33+
34+
```html
35+
<script src = "https://cdn.wilddog.com/sdk/js/2.0.0/wilddog.js"></script>
36+
```
37+
38+
详细例子请参考:[library-app的index.html](https://github.com/ubuntuvim/wildember/blob/master/tests/dummy/app/index.html)
39+
40+
配置完成之后请重启的你的APP
41+
42+
## 使用wildember的完整示例。
43+
44+
[libaray-app](https://github.com/ubuntuvim/wildember/tree/master/tests/dummy)
45+
46+
或者请直接预览:[http://wildember.ddlisting.com/](http://wildember.ddlisting.com/)
47+
48+
## 问题
49+
50+
如果使用过程发现问题请报告给我,或者直接提[issues](https://github.com/ubuntuvim/wildember/issues)。
51+
52+
## 贡献
53+
54+
如果你有更好的想法,或者你也想扩展wildember。欢迎您提交[Pull Requests](https://github.com/ubuntuvim/wildember/pulls)。
55+
56+
## 参考
57+
58+
* [https://ember-cli.com/extending/](https://ember-cli.com/extending/)
59+
* wildember的主要代码是直接从[Emberfire](https://github.com/firebase/emberfire)fork过来的,我们只是做了部分的修改。非常感谢[Emberfire](https://github.com/firebase/emberfire)为我们提供非常棒的服务!
60+
* [http://johnotander.com/ember/2014/12/14/creating-an-emberjs-addon-with-the-ember-cli/](http://johnotander.com/ember/2014/12/14/creating-an-emberjs-addon-with-the-ember-cli/)
61+
* [https://dockyard.com/blog/2014/06/24/introducing_ember_cli_addons](https://dockyard.com/blog/2014/06/24/introducing_ember_cli_addons)

0 commit comments

Comments
 (0)