Skip to content

Commit

Permalink
Update README.md as per template
Browse files Browse the repository at this point in the history
What's changed:
1. s/line-bot-sdk-php/LINE Messaging API SDK for PHP/
2. Add Introduction section
3. s/About the LINE Messaging API/Documentation/
4. Move up "Requirements" section before "Installation" section
5. Add "Help and media" section
6. Add "Versioning section"
7. Add "Contributing" section. Move hacking guide under "Contributing" section.
8. Reorganised License section as per Apache License website guidelines
  • Loading branch information
tkgauri authored Apr 11, 2019
1 parent 7da8e93 commit 14c4166
Showing 1 changed file with 53 additions and 33 deletions.
86 changes: 53 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
line-bot-sdk-php
==
# LINE Messaging API SDK for PHP

[![Build Status](https://travis-ci.org/line/line-bot-sdk-php.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-php)

SDK of the LINE Messaging API for PHP.

About the LINE Messaging API
--
## Introduction

The LINE Messaging API SDK for PHP makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.


## Documentation

See the official API documentation for more information.

English: [https://developers.line.me/en/docs/](https://developers.line.me/en/docs/)<br>
Japanese: [https://developers.line.me/ja/docs/](https://developers.line.me/ja/docs/)
- English: https://developers.line.biz/en/docs/messaging-api/overview/
- Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/


## Requirements

- PHP 5.5 or later

Installation
--

## Installation

Install the LINE Messaging API SDK using [Composer](https://getcomposer.org/).

```
$ composer require linecorp/line-bot-sdk
```

Getting started
--
## Getting started

### Create the bot client instance

Expand Down Expand Up @@ -66,8 +72,7 @@ echo $response->getHTTPStatus() . ' ' . $response->getRawBody();
`LINEBot#replyMessage()` takes the reply token and `MessageBuilder`.
The method sends a message that is built by `MessageBuilder` to the destination.

Components
--
## Components

### MessageBuilder

Expand Down Expand Up @@ -134,7 +139,7 @@ The following examples show how webhooks are handled:
More information
--

For more information, see the [official API documents](#about-the-line-messaging-api) and PHPDoc.
For more information, see the [official API documents](#documentation) and PHPDoc.
If it's your first time using this library, we recommend taking a look at `examples` and the PHPDoc of `\LINE\LINEBot`.

Hints
Expand Down Expand Up @@ -166,7 +171,7 @@ The HTML files are generated in `docs/`.

### Official API documentation

[Official API documents](#about-the-line-messaging-api) shows the detail of Messaging API and fundamental usage of SDK.
[Official API documents](#documentation) shows the detail of Messaging API and fundamental usage of SDK.

Notes
--
Expand All @@ -178,15 +183,6 @@ Notes

Please refer [CurlHTTPClient](/src/LINEBot/HTTPClient/CurlHTTPClient.php) that is the default HTTP client implementation.

Requirements
--

- PHP 5.5 or later

For SDK developers
--

Please refer [HACKING.md](/HACKING.md).

See also
--
Expand All @@ -196,21 +192,45 @@ See also
A very simple SDK (subset) for the LINE Messaging API for PHP.
line-bot-sdk-tiny provides a simple interface and functions which makes it a good way to learn how to use the LINE Messaging API.

License
--
## Help and media

FAQ: https://developers.line.biz/en/faq/

Community Q&A: https://www.line-community.me/questions

News: https://developers.line.biz/en/news/

Twitter: [@LINE_DEV](https://twitter.com/LINE_DEV)


## Versioning

This project respects semantic versioning.

See http://semver.org/


## Contributing

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

For hacking instructions, please refer [HACKING.md](/HACKING.md).


## License

```
Copyright 2016 LINE Corporation
LINE Corporation licenses this file to you under the Apache License,
version 2.0 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at:
Licensed under the Apache License, version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

0 comments on commit 14c4166

Please sign in to comment.