Documentation cleanup #208
Conversation
README.md
Outdated
|
|
||
| SDK that wraps the SmartThings REST API and reduces the amount of code necessary to write a SmartApp app. It supports | ||
| both webhook and AWS Lambda implementations. This is a preview version of the API and will change over time time. | ||
| Looking for reference documentation? Find it [here](docs/index.md). |
There was a problem hiding this comment.
I've been trying to avoid "here" or "click here" links. Is there some new thing that makes them ok again?
There was a problem hiding this comment.
How about we phrase it something like this:
For a detailed look at the API, see the reference documentation.
README.md
Outdated
| * _Axios is now used rather than request-promise-native for making HTTP calls, resulting in changes to the error | ||
| >**Version 2.0 Release** | ||
| > | ||
| >This is a preview version of the API and will change over time. |
There was a problem hiding this comment.
I'm not sure this makes sense anymore. Maybe @bflorian can comment. Also, it's a little odd to mix it in with the version 2.0 information, to which is is unrelated.
There was a problem hiding this comment.
I think we can just remove this line about the SDK being a preview version.
README.md
Outdated
| * _Axios is now used rather than request-promise-native for making HTTP calls, resulting in changes to the error | ||
| >**Version 2.0 Release** | ||
| > | ||
| >This is a preview version of the API and will change over time. |
There was a problem hiding this comment.
I think we can just remove this line about the SDK being a preview version.
README.md
Outdated
|
|
||
| SDK that wraps the SmartThings REST API and reduces the amount of code necessary to write a SmartApp app. It supports | ||
| both webhook and AWS Lambda implementations. This is a preview version of the API and will change over time time. | ||
| Looking for reference documentation? Find it [here](docs/index.md). |
There was a problem hiding this comment.
How about we phrase it something like this:
For a detailed look at the API, see the reference documentation.
README.md
Outdated
| >This is a preview version of the API and will change over time. | ||
| > | ||
| >*This major release is not completely backwardly compatible with version 1.X*, though for most SmartApps the changes required should be relatively minor. The major non-backwards compatible changes include: | ||
| >* _Methods that return lists now return arrays rather that an object with the properties `items` and `_links`._ |
There was a problem hiding this comment.
rather that an object instead of objects
README.md
Outdated
| >See the [Version 2.0.0 release notes](docs/V2_RELEASE_NOTES.md) for more information. | ||
| _See the [Version 2.0.0 release notes](docs/V2_RELEASE_NOTES.md) for more information._ | ||
| This SDK includes a set of NodeJS libraries for building Webhook and AWS Lambda SmartApps, and interacting with the public SmartThings API. |
There was a problem hiding this comment.
A nit, but Node.js is a more popular way of writing it.
There was a problem hiding this comment.
Revised, thanks for catching that.
|
🎉 This PR is included in version 2.6.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
4 participants
Types of changes