Browse Source

Merge branch 'master' into dev

Arnim Läuger 7 years ago
parent
commit
787379f0f5
2 changed files with 7 additions and 7 deletions
  1. 6 6
      README.md
  2. 1 1
      docs/en/modules/mdns.md

+ 6 - 6
README.md

@@ -2,7 +2,7 @@
 
 [![Join the chat at https://gitter.im/nodemcu/nodemcu-firmware](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/nodemcu/nodemcu-firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://travis-ci.org/nodemcu/nodemcu-firmware.svg)](https://travis-ci.org/nodemcu/nodemcu-firmware)
-[![Documentation Status](https://img.shields.io/badge/docs-dev-yellow.svg?style=flat)](http://nodemcu.readthedocs.io/en/dev/)
+[![Documentation Status](https://img.shields.io/badge/docs-master-yellow.svg?style=flat)](http://nodemcu.readthedocs.io/en/master/)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/nodemcu/nodemcu-firmware/blob/master/LICENSE)
 
 ### A Lua based firmware for ESP8266 WiFi SOC
@@ -45,14 +45,14 @@ wifi.sta.config("SSID", "password")
 
 The entire [NodeMCU documentation](https://nodemcu.readthedocs.io) is maintained right in this repository at [/docs](docs). The fact that the API documentation is maintained in the same repository as the code that *provides* the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at [https://nodemcu.readthedocs.io](https://nodemcu.readthedocs.io). 
 
-- How to [build the firmware](https://nodemcu.readthedocs.io/en/dev/en/build/)
-- How to [flash the firmware](https://nodemcu.readthedocs.io/en/dev/en/flash/)
-- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/dev/en/upload/)
+- How to [build the firmware](https://nodemcu.readthedocs.io/en/master/en/build/)
+- How to [flash the firmware](https://nodemcu.readthedocs.io/en/master/en/flash/)
+- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/master/en/upload/)
 - API documentation for every module
 
 # Releases
 
-Due to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated [custom firmware build service](http://nodemcu-build.com/) to get the specific firmware configuration you need, or consult the [documentation](http://nodemcu.readthedocs.io/en/dev/en/build/) for other options to build your own firmware.
+Due to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated [custom firmware build service](http://nodemcu-build.com/) to get the specific firmware configuration you need, or consult the [documentation](http://nodemcu.readthedocs.io/en/master/en/build/) for other options to build your own firmware.
 
 This project uses two main branches, `master` and `dev`. `dev` is actively worked on and it's also where PRs should be created against. `master` thus can be considered "stable" even though there are no automated regression tests. The goal is to merge back to `master` roughly every 2 months. Depending on the current "heat" (issues, PRs) we accept changes to `dev` for 5-6 weeks and then hold back for 2-3 weeks before the next snap is completed.
 
@@ -60,7 +60,7 @@ A new tag is created every time `dev` is merged back to `master`. They are liste
 
 # Support
 
-See [https://nodemcu.readthedocs.io/en/dev/en/support/](https://nodemcu.readthedocs.io/en/dev/en/support/).
+See [https://nodemcu.readthedocs.io/en/master/en/support/](https://nodemcu.readthedocs.io/en/master/en/support/).
 
 # License
 

+ 1 - 1
docs/en/modules/mdns.md

@@ -23,7 +23,7 @@ The specific names are:
 
 - `port` The port number for the service. Default value is 80.
 - `service` The name of the service. Default value is 'http'.
-- `dscription` A short phrase (under 63 characters) describing the service. Default is the hostname.
+- `description` A short phrase (under 63 characters) describing the service. Default is the hostname.
 
 #### Returns
 `nil`