diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..7d89e3d --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust Build && Test + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose diff --git a/README.md b/README.md index ff262a0..09858ca 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # acapair_chat_api Acapair Chat API + +[![Rust Build && Test](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml/badge.svg)](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml) + + +## Exposed URLs +> ':' means they are variable. + +Alive Ping(get): "/" + +--- + +Send Message(post): "/send" + +| Body Fields | Example Values | +| -------- | ------- | +| "room_id" | "Tahinli's Room -1" | +| "username" | "Tahinli" | +| "message" | "Hi!" | + +--- + +Receive Message(get): "/receive/:room_id" \ No newline at end of file