From 7e875f0f8d6da692564c92915a6c2d143544008c Mon Sep 17 00:00:00 2001 From: Volodymyr Shymanskyy Date: Tue, 25 Sep 2018 13:42:49 +0300 Subject: [PATCH] Update Readme --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 60 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3aa283d..3eac137 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,40 @@ **Warning:** Work in progress. Code reviews and contributions are more than welcome! -Supports: -- Python 2 and Python 3 -- Windows, Linux, OSX -- Micropython (PyCom WiPy, LoPy) -- Virtual pins (see examples) +[![GitHub version](https://img.shields.io/github/release/vshymanskyy/blynk-library-python.svg)](https://github.com/vshymanskyy/blynk-library-python/releases/latest) +[![GitHub download](https://img.shields.io/github/downloads/vshymanskyy/blynk-library-python/total.svg)](https://github.com/vshymanskyy/blynk-library-python/releases/latest) +[![GitHub stars](https://img.shields.io/github/stars/vshymanskyy/blynk-library-python.svg)](https://github.com/vshymanskyy/blynk-library-python/stargazers) +[![GitHub issues](https://img.shields.io/github/issues/vshymanskyy/blynk-library-python.svg)](https://github.com/vshymanskyy/blynk-library-python/issues) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vshymanskyy/blynk-library-python/blob/master/LICENSE) -## Installation +If you like **Blynk** - give it a star, or fork it and contribute! +[![GitHub stars](https://img.shields.io/github/stars/blynkkk/blynk-library.svg?style=social&label=Star)](https://github.com/blynkkk/blynk-library/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/blynkkk/blynk-library.svg?style=social&label=Fork)](https://github.com/blynkkk/blynk-library/network) +__________ -```sh -pip install blynk-library-python -``` +## What is Blynk? +Blynk provides iOS and Android apps to control any hardware over the Internet or directly using Bluetooth. +You can easily build graphic interfaces for all your projects by simply dragging and dropping widgets, right on your smartphone. +Blynk is the most popular IoT platform used by design studios, makers, educators, and equipment vendors all over the world. + +![Dashboard](https://github.com/blynkkk/blynk-server/blob/master/docs/overview/dash.png) +![Widgets Box](https://github.com/blynkkk/blynk-server/blob/master/docs/overview/widgets_box.png) + +## Download + +**Blynk App: [Google Play](https://play.google.com/store/apps/details?id=cc.blynk) / [App Store](https://itunes.apple.com/us/app/blynk-control-arduino-raspberry/id808760481?ls=1&mt=8)** -## Usage +**Blynk [Server](https://github.com/blynkkk/blynk-server)** + +## Documentation +Social: [Webpage](http://www.blynk.cc) / [Facebook](http://www.fb.com/blynkapp) / [Twitter](http://twitter.com/blynk_app) / [Kickstarter](https://www.kickstarter.com/projects/167134865/blynk-build-an-app-for-your-arduino-project-in-5-m/description) +Help Center: http://help.blynk.cc +Documentation: http://docs.blynk.cc/#blynk-firmware +Community Forum: http://community.blynk.cc +Examples Browser: http://examples.blynk.cc +Blynk for Business: http://www.blynk.io + +## Usage example ```py import BlynkLib @@ -39,6 +60,19 @@ def my_read_handler(): blynk.run() ``` +## Installation + +```sh +pip install blynk-library-python +``` + +## Features +- Python 2 and Python 3 +- Windows, Linux, OSX +- Micropython (PyCom WiPy, LoPy) +- Virtual pins (see examples) + + ## Notes For some devices (like PyCom WiPy) you need to setup internet connection first: @@ -52,3 +86,19 @@ wlan = WLAN(mode=WLAN.STA) wlan.connect(WIFI_SSID, auth=WIFI_AUTH, timeout=5000) print(wlan.ifconfig()) ``` + +__________ + +### Implementations for other platforms +* [Arduino](https://github.com/blynkkk/blynk-library) +* [Particle](https://github.com/vshymanskyy/blynk-library-spark) +* [Lua, OpenWrt, NodeMCU](https://github.com/vshymanskyy/blynk-library-python) +* [Node.js, Espruino, Browsers](https://github.com/vshymanskyy/blynk-library-js) +* [OpenWrt packages](https://github.com/vshymanskyy/blynk-library-openwrt) +* [MBED](https://developer.mbed.org/users/vshymanskyy/code/Blynk/) +* [Node-RED](https://www.npmjs.com/package/node-red-contrib-blynk-ws) +* [LabVIEW](https://github.com/juncaofish/NI-LabVIEWInterfaceforBlynk) +* [C#](https://github.com/sverrefroy/BlynkLibrary) + +### License +This project is released under The MIT License (MIT)