Skip to content

Commit 229f1e3

Browse files
authored
Use README template
- s/Line::Bot::API/LINE Messaging API SDK for Ruby/ - Added "Introduction" section - Updated "Documentation" links from reference to Messaging api overview links - Moved up "Installation section" - Added "Help and media" and "Contributing" section - Added "License" contents inside comment
1 parent 6580e77 commit 229f1e3

File tree

1 file changed

+48
-28
lines changed

1 file changed

+48
-28
lines changed

README.md

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
1-
# Line::Bot::API
1+
# LINE Messaging API SDK for Ruby
22

33
[![Gem-version](https://img.shields.io/gem/v/line-bot-api.svg)](https://rubygems.org/gems/line-bot-api) [![Build Status](https://travis-ci.org/line/line-bot-sdk-ruby.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-ruby)
44

55

6-
Line::Bot::API - SDK of the LINE Messaging API for Ruby.
6+
## Introduction
7+
The LINE Messaging API SDK for Ruby makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.
78

8-
## About the LINE Messaging API
9+
## Documentation
910

10-
See the official API reference documentation for more information.
11+
See the official API documentation for more information
1112

12-
https://developers.line.me/en/docs/messaging-api/reference/
13+
- English: https://developers.line.biz/en/docs/messaging-api/overview/
14+
- Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
15+
16+
## Installation
17+
18+
Add this line to your application's Gemfile:
19+
20+
```ruby
21+
gem 'line-bot-api'
22+
```
23+
24+
And then execute:
25+
26+
$ bundle
27+
28+
Or install it yourself as:
29+
30+
$ gem install line-bot-api
1331

1432
## Synopsis
1533

@@ -58,34 +76,36 @@ post '/callback' do
5876
end
5977
```
6078

61-
## Installation
79+
## Help and media
80+
FAQ: https://developers.line.biz/en/faq/
6281

63-
Add this line to your application's Gemfile:
82+
Community Q&A: https://www.line-community.me/questions
6483

65-
```ruby
66-
gem 'line-bot-api'
67-
```
84+
News: https://developers.line.biz/en/news/
6885

69-
And then execute:
86+
Twitter: @LINE_DEV
7087

71-
$ bundle
88+
## Versioning
89+
This project respects semantic versioning.
7290

73-
Or install it yourself as:
91+
See http://semver.org/
7492

75-
$ gem install line-bot-api
93+
## Contributing
94+
Please check [CONTRIBUTING](contributing.md) before making a contribution.
7695

7796
## License
78-
79-
Copyright (C) 2016 LINE Corporation.
80-
81-
Licensed under the Apache License, Version 2.0 (the "License");
82-
you may not use this file except in compliance with the License.
83-
You may obtain a copy of the License at
84-
85-
http://www.apache.org/licenses/LICENSE-2.0
86-
87-
Unless required by applicable law or agreed to in writing, software
88-
distributed under the License is distributed on an "AS IS" BASIS,
89-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
90-
See the License for the specific language governing permissions and
91-
limitations under the License.
97+
```
98+
Copyright (C) 2016 LINE Corp.
99+
100+
Licensed under the Apache License, Version 2.0 (the "License");
101+
you may not use this file except in compliance with the License.
102+
You may obtain a copy of the License at
103+
104+
http://www.apache.org/licenses/LICENSE-2.0
105+
106+
Unless required by applicable law or agreed to in writing, software
107+
distributed under the License is distributed on an "AS IS" BASIS,
108+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
109+
See the License for the specific language governing permissions and
110+
limitations under the License.
111+
```

0 commit comments

Comments
 (0)