Merge pull request #17 from nanato12/feature/update

Update v0.1.0

Author: nanato12

Cargo.toml

@@ -3,11 +3,20 @@ name = "line-bot-sdk-rust"
 version = "0.1.0"
 authors = ["nanato12 <admin@nanato12.info>"]
 edition = "2018"
+description = "LINE Messaging API SDK for Rust"
+readme = "README.md"
+repository = "https://github.com/nanato12/line-bot-sdk-rust/"
+license = "Apache-2.0"
+license-file = "LICENSE"
+keywords = ["line", "linebot", "line-bot-sdk", "line-messaging-api"]
+categories = ["api-bindings"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[features]
+default = []
+rocket_support = ["rocket"]
 
 [dependencies]
-rocket = "0.4"
+rocket = { version = "0.4", optional = true }
 reqwest = { version = "0.11.0", features = ["blocking", "json"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"

README.md

@@ -1,2 +1,66 @@
-# line-bot-sdk-rust
-rust製 linebot sdk
+# LINE Messaging API SDK for Rust
+## Introduction
+The LINE Messaging API SDK for Rust 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.biz/en/docs/messaging-api/overview/>
+- Japanese: <https://developers.line.biz/ja/docs/messaging-api/overview/>
+## Requirements
+This library requires Rust nightly.
+## Installation
+```
+[dependencies]
+line-bot-sdk-rust = "0.1"
+```
+If you use `rocket support`.
+```
+[dependencies]
+line-bot-sdk-rust = { version = "0.1", features = ["rocket_support"] }
+```
+## Configuration
+```
+extern crate line_bot_sdk_rust as line;
+use line::bot::LineBot;
+
+fn main() {
+    let bot = LineBot::new("<channel secret>", "<channel access token>");
+}
+```
+## How to use
+The LINE Messaging API uses the JSON data format.
+ parse_event_request() will help you to parse the HttpRequest content and return a Result<[Events](`events::Events`) , &'static str> Object.
+ ```
+ let result: Result<Events, &'static str> =
+     bot.parse_event_request(signature, body);
+ ```
+
+ ```
+ match result {
+     Ok(events) => {
+         for event in events.events {
+             ...
+         }
+     }
+     Err(msg) => {}
+ }
+ ```
+
+## Contributing
+Please make a contribution 😆
+
+## License
+```
+ Copyright 2021 nanato12
+
+ 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
+
+     http://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.
+ ```

src/support/mod.rs

@@ -1,3 +1,4 @@
 //! Support for framework
 
+#[cfg(feature = "rocket_support")]
 pub mod rocket_support;