Skip to content

Commit ca3e375

Browse files
tkgauribe-hase
authored andcommitted
Update README as per template (#159)
* Update README as per template - s/line-bot-sdk-python/LINE Messaging API SDK for Python - Change documentation links from api reference to messaging api overview - Add "Introduction" section - s/Install/Installation/ - Move up "Requirements" section - Add "Help and media" section - Add "Versioning" section - Add "Contributing" section - Add "License" section * Polish
1 parent ad9ca6b commit ca3e375

File tree

1 file changed

+57
-12
lines changed

1 file changed

+57
-12
lines changed

README.rst

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
1-
line-bot-sdk-python
2-
===================
1+
LINE Messaging API SDK for Python
2+
=================================
33

44
|Build Status| |PyPI version| |Documentation Status|
55

66
SDK of the LINE Messaging API for Python.
77

8-
About the LINE Messaging API
9-
----------------------------
8+
Introduction
9+
------------
10+
The LINE Messaging API SDK for Python makes it easy to develop bots using LINE Messaging API, and you can create a sample bot within minutes.
1011

11-
See the official API documentation for more information.
1212

13-
English: https://developers.line.me/en/docs/messaging-api/reference/
13+
Documentation
14+
-------------
1415

15-
Japanese: https://developers.line.me/ja/docs/messaging-api/reference/
16+
See the official API documentation for more information
1617

17-
Install
18-
-------
18+
English: https://developers.line.biz/en/docs/messaging-api/overview/
19+
20+
Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
21+
22+
Requirements
23+
------------
24+
25+
- Python >= 2.7 or >= 3.4
26+
27+
Installation
28+
------------
1929

2030
::
2131

@@ -839,10 +849,25 @@ API documentation
839849

840850
OR |Documentation Status|
841851

842-
Requirements
843-
------------
852+
Help and media
853+
--------------
854+
FAQ: https://developers.line.biz/en/faq/
844855

845-
- Python >= 2.7 or >= 3.4
856+
Community Q&A: https://www.line-community.me/questions
857+
858+
News: https://developers.line.biz/en/news/
859+
860+
Twitter: @LINE_DEV
861+
862+
Versioning
863+
----------
864+
This project respects semantic versioning
865+
866+
See http://semver.org/
867+
868+
Contributing
869+
------------
870+
Please check `CONTRIBUTING <contributing.md>`__ before making a contribution.
846871

847872
For SDK developers
848873
------------------
@@ -889,3 +914,23 @@ And more... TBD
889914
:target: https://badge.fury.io/py/line-bot-sdk
890915
.. |Documentation Status| image:: https://readthedocs.org/projects/line-bot-sdk-python/badge/?version=latest
891916
:target: http://line-bot-sdk-python.readthedocs.io/en/latest/?badge=latest
917+
918+
919+
License
920+
--------
921+
922+
::
923+
924+
Copyright (C) 2016 LINE Corp.
925+
926+
Licensed under the Apache License, Version 2.0 (the "License");
927+
you may not use this file except in compliance with the License.
928+
You may obtain a copy of the License at
929+
930+
http://www.apache.org/licenses/LICENSE-2.0
931+
932+
Unless required by applicable law or agreed to in writing, software
933+
distributed under the License is distributed on an "AS IS" BASIS,
934+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
935+
See the License for the specific language governing permissions and
936+
limitations under the License.

0 commit comments

Comments
 (0)