Skip to content

Commit

Permalink
[doc]: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pizn committed Jan 20, 2016
1 parent 6822443 commit 8fdf4b4
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,24 @@

[![Build Status](https://travis-ci.org/pizn/eevee.svg?branch=master)](https://travis-ci.org/pizn/eevee)

基于 Github Page 的在线编辑平台,让你更加专注于内容的编写.
基于 Github Pages 的在线编辑平台,让你更加专注于内容的编写.

### 初衷

像黑客一样写博客太麻烦了,直接就在浏览器,专注于内容不是更好么?于是就有了它的诞生.
像黑客一样写博客太麻烦了 -- 需要在你的编辑器(Vim/Mou...)打开项目,然后编辑一篇 markdown 文章,写完之后还要 add/commit/push 等动作.为何不能简单些呢?我只关注于内容不是更好么?于是就有了这样的一个想法,需要有一个工具,让我可以在任何地方,任何时候,想写就写.这个工具,它就是 `伊布`.为喜欢在 GitHub 上分享文章的人精心打造.

### 构成
### 构成及原理

纯前端实现,通过 GitHub API 与你在 GitHub 上的代码库取得联系,可以在 `Eevee` 上完成你对文章协作的需求.
纯前端实现,可以说没有 Server 层.通过 GitHub API 与你在 GitHub 上的代码库取得联系,获取 Project 的文章(_posts/),完成增删查改的功能.依赖的数据前提:

* GitHub 账号(只在浏览器中记录)
* 基于 Jekyll 创建好的 Pages 项目, 文章存放在 `_posts` 目录下

### 如何使用

1. 使用 GitHub 账号登录 Eevee(前提是你已经基于 GitHub Pages 简历好博客了
1. 使用 GitHub 账号登录 Eevee(前提是你已经基于 GitHub Pages 建立好博客
2. 选择文件,编辑, `Command + s` 保存即可
3. 稍等片刻,你的博客则刷新出新的文章了
3. 稍等片刻,你的博客则刷新出新的文章

### 参与开发

Expand Down

0 comments on commit 8fdf4b4

Please sign in to comment.