Skip to content

Commit

Permalink
Add license and README
Browse files Browse the repository at this point in the history
  • Loading branch information
RAnders00 committed Aug 16, 2023
1 parent f0dcbe2 commit 40a9cd6
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Ruben Anders

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# recent-messages-formatter

## Usage

```
Simple program to fetch a Twitch channel's recent messages and to print all normal messages in a simple readable format.
Usage: recent-messages-formatter <CHANNEL_LOGIN>
Arguments:
<CHANNEL_LOGIN> The channel login of the Twitch channel to fetch. E.g. `pajlada` or `riotgames`
Options:
-h, --help Print help
-V, --version Print version
```

## Building

1. Install Rust (https://www.rust-lang.org/)
2. `git clone https://github.com/robotty/recent-messages-formatter.git`
3. `cd recent-messages-formatter`
4. `cargo build --release`
5. You can find the built executable in `./target/release/recent-messages-formatter`. Feel free to copy this file to wherever you need it, it does not need any other files around it (It is statically linked).
6. Try it out: `./target/release/recent-messages-formatter pajlada`

This process works on Linux, Mac and Windows. Note that on Windows, `./target/release/recent-messages-formatter` becomes `./target/release/recent-messages-formatter.exe`.

0 comments on commit 40a9cd6

Please sign in to comment.