Skip to content

Commit

Permalink
Bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanwinchester committed Jul 29, 2020
1 parent 855bdcd commit ab5f332
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Connect to Twitch chat with Elixir.

Inspired by [tmi.js](https://github.com/tmijs/tmi.js).
The name is inspired by [tmi.js](https://github.com/tmijs/tmi.js).

## Installation

Expand All @@ -11,7 +11,7 @@ The package can be installed by adding `tmi` to your list of dependencies in `mi
```elixir
def deps do
[
{:tmi, "~> 0.2.0"},
{:tmi, "~> 0.3.0"},
]
end
```
Expand Down Expand Up @@ -43,7 +43,7 @@ end

handle_connected(server, port)
handle_logged_in()
handle_login_failed(reason :: atom)
handle_login_failed(reason)
handle_disconnected()
handle_join(chat)
handle_join(chat, user)
Expand Down Expand Up @@ -100,8 +100,14 @@ children = [
```


To send a message:
The handler is for handling incoming messages, whispers, etc.

However, what if you want to interact?

```elixir
TMI.message("mychat", "Hello World")

TMI.whisper("some_user", "Hey there")

TMI.action("mychat", "jumps around frantically")
```
4 changes: 2 additions & 2 deletions lib/tmi.ex
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ defmodule TMI do
end

@doc """
Determine if the provided client process has an open connection to a server.
Determine if the client process has an open connection to a server.
"""
@spec is_connected?() :: true | false
def is_connected? do
GenServer.call(__MODULE__, :is_connected?)
end

@doc """
Determine if the provided client is logged on to a server.
Determine if the client is logged on to a server.
"""
@spec is_logged_on?() :: true | false
def is_logged_on? do
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule TMI.MixProject do
def project do
[
app: :tmi,
version: "0.2.0",
version: "0.3.0",
elixir: "~> 1.10",
start_permanent: Mix.env() == :prod,
deps: deps(),
Expand Down

0 comments on commit ab5f332

Please sign in to comment.