Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
noahziheng committed Mar 2, 2018
1 parent 64041b6 commit a543b80
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 25 deletions.
Binary file modified .DS_Store
Binary file not shown.
4 changes: 3 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"default": true,
"MD013": false,
"MD033": false
"MD033": false,
"MD041": false,
"MD002": false
}
62 changes: 38 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,50 @@
<h1 align="center">
<img src="https://raw.githubusercontent.com/noahziheng/freeiot/master/icons/playstore/icon.png" width="128">
<br/>
FreeIOT
</h1>
<h3 align="center">
A free, open-source Internet-Of-Thing Framework.<br>
For improving developement experience and reducing development threshold.
</h3>
<p align="center">
<img alt="Documentation Build" src="https://api.travis-ci.org/noahziheng/freeiot.svg">
<img alt="Release Version" src="https://img.shields.io/badge/release-v0.9.0-brightgreen.svg">
<img alt="GPLv3" src="https://img.shields.io/badge/license-GPLv3-red.svg">
</p>
![Banner](./icons/code.png)

[中文说明在此](https://github.com/noahziheng/freeiot)
# FreeIOT

## Documentation
> 一个轻巧灵活的开源物联网中间件框架
[Documentation Here](http://doc.iot.noahgao.net)
![Documentation Build](https://api.travis-ci.org/noahziheng/freeiot.svg)
[![pypi](https://img.shields.io/pypi/v/libfreeiot.svg)](https://pypi.org/project/libfreeiot/)
[![license](https://img.shields.io/github/license/noahziheng/freeiot.svg?style=flat-square)](./LICENSE.txt)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

## Related Project
[English Introduction](./README_en.md)

- [FreeIOT](https://github.com/noahziheng/freeiot)
- [FreeIOT Firmware](https://github.com/noahziheng/freeiot-firmware)
## 安装

## Donation
### 通过包管理器安装

Alipay: [email protected] (\*梓恒)
```shell
pip install libfreeiot
```

> If you feel that my job is good for you, then you can donate operating expenses for the project.
### 构建安装

## License
```shell
git clone https://github.com/noahziheng/freeiot.git
cd freeiot
python3 setup.py install --user # *nix 类系统使用
python setup.py install --user # Windows 系统使用
```

## 文档

[点击进入文档中心](https://noahziheng.github.io/freeiot)

## 相关项目

- [Flask](https://github.com/pallets/flask)
- [PyMongo](https://github.com/mongodb/mongo-python-driver)
- [Eclipse Paho](https://www.eclipse.org/paho/)

## 捐助

支付宝:[email protected] (\*梓恒)

> 如果我的工作对您有所帮助,欢迎您对本项目进行捐助。
## 开源授权

Copyright (C) 2017 Noah Gao <[email protected]>

Expand Down
52 changes: 52 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
![Banner](./icons/code.png)

# FreeIOT

> A lightweight, flexible and open-source Middleware Internet-Of-Thing Framework.
![Documentation Build](https://api.travis-ci.org/noahziheng/freeiot.svg)
[![pypi](https://img.shields.io/pypi/v/libfreeiot.svg)](https://pypi.org/project/libfreeiot/)
[![license](https://img.shields.io/github/license/noahziheng/freeiot.svg?style=flat-square)](./LICENSE.txt)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[English Introduction](./README_en.md)

## Installation

### Via Package Manager

```shell
pip install libfreeiot
```

### Build Setup

```shell
git clone https://github.com/noahziheng/freeiot.git
cd freeiot
python3 setup.py install --user # On *nix-like system
python setup.py install --user # On Windows system
```

## Documentation

[Documentation Here](https://noahziheng.github.io/freeiot)

## Related Project

- [Flask](https://github.com/pallets/flask)
- [PyMongo](https://github.com/mongodb/mongo-python-driver)
- [Eclipse Paho](https://www.eclipse.org/paho/)

## Donation

Alipay: [email protected] (\*梓恒)

> If you feel that my job is good for you, then you can donate operating expenses for the project.
## License

Copyright (C) 2017 Noah Gao <[email protected]>

Licensed under the GNU General Public License (GPL) v3.
For more information see LICENSE.txt.
15 changes: 15 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
<h1 align="center">
<img src="https://raw.githubusercontent.com/noahziheng/freeiot/master/icons/playstore/icon.png" width="128">
<br/>
FreeIOT
</h1>
<h3 align="center">
开源免费的物联网中间件框架<br>
更好的开发体验,更低的开发门槛
</h3>
<p align="center">
<img alt="Documentation Build" src="https://api.travis-ci.org/noahziheng/freeiot.svg">
<img alt="Release Version" src="https://img.shields.io/badge/release-v0.9.0-brightgreen.svg">
<img alt="GPLv3" src="https://img.shields.io/badge/license-GPLv3-red.svg">
</p>

# FreeIOT 文档中心
FreeIOT是一个自由、开源的物联网开发套件/平台,项目致力于提高物联网开发者的开发体验,降低物联网设备的开发门槛,将在保证性能的前提下提供最优的体验。项目完全基于GPLv3开源,您可在任一开源项目内使用来自FreeIOT的代码或开放资源。

Expand Down
Binary file added icons/code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a543b80

Please sign in to comment.