Skip to content

Commit 3ce1c0e

Browse files
tkgaurikawasako
authored andcommitted
Update README file as per template (#141)
- s/line-bot-sdk-nodejs/LINE Messaging API SDK for nodejs/ - Add "Introduction" section - Move up "Documentation" section and changed links from Messaging API reference to Messaging API overview. - Move up "Requirements" section - Change minimum required version from 6 to 8 - Add "Help and media" section - Add "Versioning" section - Add Apache License boilerplate
1 parent d18af23 commit 3ce1c0e

File tree

1 file changed

+40
-20
lines changed

1 file changed

+40
-20
lines changed

README.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,64 @@
1-
# line-bot-sdk-nodejs
1+
# LINE Messaging API SDK for nodejs
22

33
[![Travis CI](https://travis-ci.org/line/line-bot-sdk-nodejs.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-nodejs)
44
[![npmjs](https://badge.fury.io/js/%40line%2Fbot-sdk.svg)](https://www.npmjs.com/package/@line/bot-sdk)
55

6-
Node.js SDK for LINE Messaging API
76

8-
## Getting Started
7+
## Introduction
8+
The LINE Messaging API SDK for nodejs makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.
99

10-
### Install
10+
## Documentation
11+
12+
See the official API documentation for more information
13+
14+
- English: https://developers.line.biz/en/docs/messaging-api/overview/
15+
- Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
16+
17+
line-bot-sdk-nodejs documentation: https://line.github.io/line-bot-sdk-nodejs/#getting-started
18+
19+
## Requirements
20+
21+
* **Node.js** 8 or higher
22+
23+
## Installation
1124

1225
Using [npm](https://www.npmjs.com/):
1326

1427
``` bash
1528
$ npm install @line/bot-sdk --save
1629
```
1730

18-
### Documentation
19-
20-
For guide, API reference, and other information, please refer to
21-
the [documentation](https://line.github.io/line-bot-sdk-nodejs/).
31+
## Help and media
32+
FAQ: https://developers.line.biz/en/faq/
2233

23-
### LINE Messaging API References
34+
Community Q&A: https://www.line-community.me/questions
2435

25-
Here are links to official references for LINE Messaging API. It is recommended
26-
reading them beforehand.
36+
News: https://developers.line.biz/en/news/
2737

28-
* LINE API Reference [EN](https://developers.line.me/en/docs/messaging-api/reference/) [JA](https://developers.line.me/ja/docs/messaging-api/reference/)
29-
* LINE Developers - Messaging API
30-
* [Overview](https://developers.line.me/messaging-api/overview)
31-
* [Getting started](https://developers.line.me/messaging-api/getting-started)
32-
* [Joining groups and rooms](https://developers.line.me/messaging-api/joining-groups-and-rooms)
38+
Twitter: @LINE_DEV
3339

34-
## Requirements
40+
## Versioning
41+
This project respects semantic versioning
3542

36-
* **Node.js** 8 or higher
43+
See http://semver.org/
3744

3845
## Contributing
3946

4047
Please check [CONTRIBUTING](CONTRIBUTING.md) before making a contribution.
4148

4249
## License
43-
44-
[Apache License Version 2.0](LICENSE)
50+
```
51+
Copyright (C) 2016 LINE Corp.
52+
53+
Licensed under the Apache License, Version 2.0 (the "License");
54+
you may not use this file except in compliance with the License.
55+
You may obtain a copy of the License at
56+
57+
http://www.apache.org/licenses/LICENSE-2.0
58+
59+
Unless required by applicable law or agreed to in writing, software
60+
distributed under the License is distributed on an "AS IS" BASIS,
61+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
62+
See the License for the specific language governing permissions and
63+
limitations under the License.
64+
```

0 commit comments

Comments
 (0)