forked from platypush/platypush
Documentation domain name moved to docs.platypush.tech
This commit is contained in:
parent
254045283b
commit
e08d4c21b8
2 changed files with 11 additions and 11 deletions
10
README.md
10
README.md
|
@ -2,7 +2,7 @@ Platypush
|
||||||
=========
|
=========
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/BlackLight/platypush.svg?branch=master)](https://travis-ci.org/BlackLight/platypush)
|
[![Build Status](https://travis-ci.org/BlackLight/platypush.svg?branch=master)](https://travis-ci.org/BlackLight/platypush)
|
||||||
[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://platypush.readthedocs.io/en/latest/?badge=latest)
|
[![Documentation Status](https://readthedocs.org/projects/platypush/badge/?version=latest)](https://docs.platypush.tech/en/latest/)
|
||||||
[![pip version](https://img.shields.io/pypi/v/platypush.svg?style=flat)](https://pypi.python.org/pypi/platypush/)
|
[![pip version](https://img.shields.io/pypi/v/platypush.svg?style=flat)](https://pypi.python.org/pypi/platypush/)
|
||||||
[![License](https://img.shields.io/github/license/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/blob/master/LICENSE.txt)
|
[![License](https://img.shields.io/github/license/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/blob/master/LICENSE.txt)
|
||||||
[![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/)
|
[![Last Commit](https://img.shields.io/github/last-commit/BlackLight/platypush.svg)](https://git.platypush.tech/platypush/platypush/-/commits/master/)
|
||||||
|
@ -14,7 +14,7 @@ Platypush
|
||||||
|
|
||||||
- The [wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) also contains many resources on getting started.
|
- The [wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) also contains many resources on getting started.
|
||||||
|
|
||||||
- Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://platypush.readthedocs.io/en/latest/).
|
- Extensive documentation for all the available integrations and messages is available on [ReadTheDocs](https://docs.platypush.tech/en/latest/).
|
||||||
|
|
||||||
- If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues).
|
- If you have issues/feature requests/enhancement ideas please [create an issue](https://git.platypush.tech/platypush/platypush/-/issues).
|
||||||
|
|
||||||
|
@ -43,7 +43,7 @@ You can use Platypush to do things like:
|
||||||
- Play local videos, YouTube videos and torrent links
|
- Play local videos, YouTube videos and torrent links
|
||||||
- Get weather forecast for your location
|
- Get weather forecast for your location
|
||||||
- Build your own web dashboard with calendar, weather, news and music controls (basically, anything that has a Platypush web widget)
|
- Build your own web dashboard with calendar, weather, news and music controls (basically, anything that has a Platypush web widget)
|
||||||
- ...and much more (basically, anything that comes with a [Platypush plugin](https://platypush.readthedocs.io/en/latest/plugins.html))
|
- ...and much more (basically, anything that comes with a [Platypush plugin](https://docs.platypush.tech/en/latest/plugins.html))
|
||||||
|
|
||||||
Imagine the ability of executing all the actions above through messages delivered through:
|
Imagine the ability of executing all the actions above through messages delivered through:
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ Imagine the ability of executing all the actions above through messages delivere
|
||||||
- [Kafka](https://kafka.apache.org)
|
- [Kafka](https://kafka.apache.org)
|
||||||
- [Redis](https://redis.io)
|
- [Redis](https://redis.io)
|
||||||
- [MQTT](https://mqtt.org)
|
- [MQTT](https://mqtt.org)
|
||||||
- ...amd much more (basically, anything that comes with a [Platypush backend](https://platypush.readthedocs.io/en/latest/backends.html))
|
- ...amd much more (basically, anything that comes with a [Platypush backend](https://docs.platypush.tech/en/latest/backends.html))
|
||||||
|
|
||||||
Imagine the ability of building custom event hooks to automatically trigger any actions:
|
Imagine the ability of building custom event hooks to automatically trigger any actions:
|
||||||
|
|
||||||
|
@ -77,7 +77,7 @@ Imagine the ability of running the application, with lots of those bundled featu
|
||||||
To get started:
|
To get started:
|
||||||
|
|
||||||
- [Wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) for installation notes, quick start, examples and architecture reference
|
- [Wiki](https://git.platypush.tech/platypush/platypush/-/wikis/home) for installation notes, quick start, examples and architecture reference
|
||||||
- [Read the docs](https://platypush.readthedocs.io/en/latest/) for a complete reference on the available plugins and backends
|
- [Read the docs](https://docs.platypush.tech/en/latest/) for a complete reference on the available plugins and backends
|
||||||
- [Blog articles](https://blog.platypush.tech) describing hands-on applications of Platypush
|
- [Blog articles](https://blog.platypush.tech) describing hands-on applications of Platypush
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
@ -40,10 +40,10 @@ device_id: myname
|
||||||
# a plugin class. The methods of the class with @action annotation will
|
# a plugin class. The methods of the class with @action annotation will
|
||||||
# be exported as runnable actions, while the __init__ parameters are
|
# be exported as runnable actions, while the __init__ parameters are
|
||||||
# configuration attributes that you can initialize in your config.yaml.
|
# configuration attributes that you can initialize in your config.yaml.
|
||||||
# Plugin classes are documented at https://platypush.readthedocs.io/en/latest/plugins.html
|
# Plugin classes are documented at https://docs.platypush.tech/en/latest/plugins.html
|
||||||
#
|
#
|
||||||
# In this example we'll configure the light.hue plugin, see
|
# In this example we'll configure the light.hue plugin, see
|
||||||
# https://platypush.readthedocs.io/en/latest/platypush/plugins/light.hue.html
|
# https://docs.platypush.tech/en/latest/platypush/plugins/light.hue.html
|
||||||
# for reference. You can easily install the required dependencies for the plugin through
|
# for reference. You can easily install the required dependencies for the plugin through
|
||||||
# pip install 'platypush[hue]'
|
# pip install 'platypush[hue]'
|
||||||
light.hue:
|
light.hue:
|
||||||
|
@ -54,14 +54,14 @@ light.hue:
|
||||||
- Living Room
|
- Living Room
|
||||||
|
|
||||||
# Example configuration of music.mpd plugin, see
|
# Example configuration of music.mpd plugin, see
|
||||||
# https://platypush.readthedocs.io/en/latest/platypush/plugins/music.mpd.html
|
# https://docs.platypush.tech/en/latest/platypush/plugins/music.mpd.html
|
||||||
# You can easily install the dependencies through pip install 'platypush[mpd]'
|
# You can easily install the dependencies through pip install 'platypush[mpd]'
|
||||||
music.mpd:
|
music.mpd:
|
||||||
host: localhost
|
host: localhost
|
||||||
port: 6600
|
port: 6600
|
||||||
|
|
||||||
# Example configuration of media.chromecast plugin, see
|
# Example configuration of media.chromecast plugin, see
|
||||||
# https://platypush.readthedocs.io/en/latest/platypush/plugins/media.chromecast.html
|
# https://docs.platypush.tech/en/latest/platypush/plugins/media.chromecast.html
|
||||||
# You can easily install the dependencies through pip install 'platypush[chromecast]'
|
# You can easily install the dependencies through pip install 'platypush[chromecast]'
|
||||||
media.chromecast:
|
media.chromecast:
|
||||||
chromecast: Living Room TV
|
chromecast: Living Room TV
|
||||||
|
@ -97,10 +97,10 @@ calendar:
|
||||||
# to happen and either trigger events or provide additional services on top of platypush.
|
# to happen and either trigger events or provide additional services on top of platypush.
|
||||||
# Just like plugins, backends are classes whose configuration matches one-to-one the
|
# Just like plugins, backends are classes whose configuration matches one-to-one the
|
||||||
# supported parameters on the __init__ methods. You can check the documentation for the
|
# supported parameters on the __init__ methods. You can check the documentation for the
|
||||||
# available backends here: https://platypush.readthedocs.io/en/latest/backends.html.
|
# available backends here: https://docs.platypush.tech/en/latest/backends.html.
|
||||||
# Moreover, most of the backends will generate events that you can react to through custom
|
# Moreover, most of the backends will generate events that you can react to through custom
|
||||||
# event hooks. Check here for the events documentation:
|
# event hooks. Check here for the events documentation:
|
||||||
# https://platypush.readthedocs.io/en/latest/events.html
|
# https://docs.platypush.tech/en/latest/events.html
|
||||||
#
|
#
|
||||||
# You may usually want to enable the HTTP backend, as it provides many useful features on
|
# You may usually want to enable the HTTP backend, as it provides many useful features on
|
||||||
# top of platypush. Among those:
|
# top of platypush. Among those:
|
||||||
|
|
Loading…
Reference in a new issue