Skip to content

Commit a6b10d0

Browse files
committed
udpated readme
1 parent 3541e14 commit a6b10d0

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Python_HomeAssistant [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![GitHub license](https://img.shields.io/github/license/wsdt/Python_HomeAssistant.svg)](https://github.com/wsdt/Python_HomeAssistant/blob/master/LICENSE) [![Generic badge](https://img.shields.io/badge/Docker-Compatible-blue.svg)](https://shields.io/)
1+
# Python_HomeAssistant [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![GitHub license](https://img.shields.io/github/license/wsdt/Python_HomeAssistant.svg)](https://github.com/wsdt/Python_HomeAssistant/blob/master/LICENSE) [![Generic badge](https://img.shields.io/badge/Docker-Compatible-blue.svg)](https://www.docker.com/)
22

3-
Easy to use home assistant to talk to, get several information, controlling your IoT-devices and the best of all **keeping your data private/locally**. Therefore, the assistant can operate offline except some enabled apis (e.g. Instagram, etc.). Would love to see some reactions (issues, pull-requests, etc.). Please note, that this project is young and has not all featured functionalities.
3+
Easy to use home assistant to talk to, get several information, controlling your IoT-devices and the best of all **keeping your data private/locally**. Therefore, the assistant can operate offline except by the use of some modules (e.g. weather module, etc.). Would love to see some reactions (issues, pull-requests, etc.). Please note, that this project is young and has not all featured functionalities.
44

55
## How to get started
6-
Start main.py to use the full functional home assistant. I recommend that you use Docker, for that I have provided a [Dockerfile](https://github.com/wsdt/Python_HomeAssistant/blob/master/docker/Dockerfile).
6+
To get your home assistant running you just have to take 1-2 steps (depends on whether you started the assistant before).
7+
1. Execute *setup.py* once, if you newly downloaded this assistant
8+
1. Execute *main.py*
79

8-
### Confidential.py
9-
You might need the CONFIDENTIAL.py file to use this assistant without restrictions. For that I provided a [CONFIDENTIAL_Template.py-File](https://github.com/wsdt/Python_HomeAssistant/blob/master/CONFIDENTIAL_Template.py)
10-
which contains example parameters. Please change all params and then rename the file to "CONFIDENTIAL.py". I added the confidential file to the projects [.gitignore](https://github.com/wsdt/Python_HomeAssistant/blob/master/.gitignore).
10+
Above steps will work assuming that you have all python libraries installed. Considering that I recommend using Docker, for that I have provided a [Dockerfile](https://github.com/wsdt/Python_HomeAssistant/blob/master/docker/Dockerfile).
1111

1212
### Docker-Ready ![Docker Build Status](https://img.shields.io/docker/build/wsdt/python_homeassistant.svg)
1313
**IMPORTANT: Dockerfile has currently two bugs.**
@@ -32,11 +32,16 @@ Project currently under development, so there are no production-ready releases y
3232

3333
## Contribution [![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
3434

35-
This project is licensed under Apache 2.0, so contributions/pull-requests are welcome. All contributors get listed here.
35+
This project is licensed under GNU V3, so contributions/pull-requests are welcome. All contributors get listed here.
3636

3737
**Contributors** [![saythanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/kennethreitz)
3838
- Kevin Riedl ([WSDT](https://github.com/wsdt))
3939

40+
### How to contribute
41+
To create new modules or changing/extending the application core, please take a look into following files, which are well commented (Better documentation follows):
42+
1. ./starterkit/abstr_answer.py --> How to create a new module
43+
1. ./setup.py --> How to install this assistant
44+
4045
### How to add an issue
4146
1. **Add a good title to your issue.** Please use a concise and precise title.
4247
* *BAD*: "ServiceMgr"

0 commit comments

Comments
 (0)