diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9607671 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/_build +/deps +erl_crash.dump +*.ez diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5ef7b58 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2013 Paul Schoenfelder + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6a92d9 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# exirc + +ExIRC is a IRC client library for Elixir projects. It aims to have a clear, well +documented API, with the minimal amount of code necessary to allow you to connect and +communicate with IRC servers effectively. It aims to implement the full RFC2812 protocol, +and relevant parts of RFC1459. + +# Why? + +I had need of this in another project of mine, and found that there were no good libraries available, +documentation was always missing, it wasn't clear how to use, and in general were not easy to work +with. + +# Status + +Just getting started, but I have most everything I need. I plan to have the basics implemented sometime +in the next week. + diff --git a/lib/exirc.ex b/lib/exirc.ex new file mode 100644 index 0000000..42a291b --- /dev/null +++ b/lib/exirc.ex @@ -0,0 +1,2 @@ +defmodule ExIrc do +end diff --git a/lib/exirc/.gitignore b/lib/exirc/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/mix.exs b/mix.exs new file mode 100644 index 0000000..830a13a --- /dev/null +++ b/mix.exs @@ -0,0 +1,24 @@ +defmodule ExIrc.Mixfile do + use Mix.Project + + def project do + [ app: :exirc, + version: "0.0.1", + elixir: "~> 0.11.2", + deps: deps ] + end + + # Configuration for the OTP application + def application do + [] + end + + # Returns the list of dependencies in the format: + # { :foobar, git: "https://github.com/elixir-lang/foobar.git", tag: "0.1" } + # + # To specify particular versions, regardless of the tag, do: + # { :barbat, "~> 0.1", github: "elixir-lang/barbat.git" } + defp deps do + [] + end +end diff --git a/test/exirc_test.exs b/test/exirc_test.exs new file mode 100644 index 0000000..c5d6ea1 --- /dev/null +++ b/test/exirc_test.exs @@ -0,0 +1,7 @@ +defmodule ExircTest do + use ExUnit.Case + + test "the truth" do + assert(true) + end +end diff --git a/test/test_helper.exs b/test/test_helper.exs new file mode 100644 index 0000000..4b8b246 --- /dev/null +++ b/test/test_helper.exs @@ -0,0 +1 @@ +ExUnit.start