Skip to content

Commit

Permalink
update: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nanato12 committed Nov 28, 2023
1 parent 5beb02e commit c456aa8
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,63 @@
# 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
```

```toml
[dependencies]
line-bot-sdk-rust = "0.1"
```

If you use `rocket support`.
```

```toml
[dependencies]
line-bot-sdk-rust = { version = "0.1", features = ["rocket_support"] }
```

If you use `actix_web support`.
```

```toml
[dependencies]
line-bot-sdk-rust = { version = "0.1", features = ["actix_support"] }
```

## Configuration
```

```rust
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.
```

```rust
let result: Result<Events, &'static str> =
bot.parse_event_request(signature, body);
```

```
```rust
match result {
Ok(events) => {
for event in events.events {
Expand All @@ -52,15 +70,15 @@ match result {

## EchoBot examples

**with Rocket framework**
### with Rocket framework

```bash
cargo run --example echobot_rocket --features=rocket_support
```

source: [rocket example](./examples/echobot_rocket.rs)

**with Actix_web framework**
### with Actix_web framework

```bash
cargo run --example echobot_actix_web --features=actix_support
Expand All @@ -69,10 +87,12 @@ cargo run --example echobot_actix_web --features=actix_support
source: [actix_web example](./examples/echobot_actix_web.rs)

## Contributing

Please make a contribution 😆

## License
```

```plain
Copyright 2021 nanato12
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down

0 comments on commit c456aa8

Please sign in to comment.