Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document requests dependency #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Document requests dependency
clach04 authored Sep 6, 2019
commit 2bd76c058400b451cc199a2fdb398f983a9deb99
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -10,6 +10,13 @@ An easy-to-use, MicroPython-compatible class to access and control lights on a P
* Works equally well in micropython or python 2.7 and up
* Easy to extend with new methods to access more bridge functionality

## Installation
For micropython, there are no requirements.

For CPython, `requests` needs to be installed, issue:

pip install requests

## Usage
The first time the `Bridge` class is used, it will discovery the bridge and then initiate the necessary API username registration.
```