diff options
author | Michael Schaefermeyer <michael.schaefermeyer@gmail.com> | 2016-07-19 01:24:13 +0200 |
---|---|---|
committer | Michael Schaefermeyer <michael.schaefermeyer@gmail.com> | 2016-07-19 01:24:20 +0200 |
commit | 3ba3d64ed675f27d3415a412121e46c4fd129a83 (patch) | |
tree | b95ed89da175cdfb5c6c35e1c03c1060eb2c5dcd | |
parent | 1678263715462aed9e03432b90a1f173284afb42 (diff) | |
download | boltex-3ba3d64ed675f27d3415a412121e46c4fd129a83.tar.gz boltex-3ba3d64ed675f27d3415a412121e46c4fd129a83.tar.xz |
Add package and docs
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | LICENSE | 13 | ||||
-rw-r--r-- | README.md | 18 | ||||
-rw-r--r-- | mix.exs | 21 | ||||
-rw-r--r-- | mix.lock | 2 |
5 files changed, 53 insertions, 2 deletions
@@ -1,5 +1,6 @@ /_build /cover +/doc /deps erl_crash.dump *.ez @@ -0,0 +1,13 @@ +Copyright 2016 Michael Schaefermeyer + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. @@ -3,6 +3,8 @@ Elixir implementation of the Bolt protocol and corresponding PackStream protocol. Both is being used by Neo4J. +*Warning: This is currently WIP and only in the wild to gather feedback!* + ## Installation If [available in Hex](https://hex.pm/docs/publish), the package can be installed as: @@ -34,3 +36,19 @@ Boltex.test 'localhost', 7687, "MATCH (n) RETURN n" - [ ] Auth - [ ] Transport adapter (e.g. plain `:gen_tcp`, `DBConnection`, ...) - [ ] Handle failures gracefully + +## License + +Copyright 2016 Michael Schaefermeyer + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. @@ -4,9 +4,11 @@ defmodule Boltex.Mixfile do def project do [app: :boltex, version: "0.0.1", - elixir: "~> 1.2", + elixir: "~> 1.3", build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, + description: "An Elixir driver for Neo4J's bolt protocol.", + package: package, deps: deps] end @@ -31,7 +33,22 @@ defmodule Boltex.Mixfile do # Type "mix help deps" for more examples and options defp deps do [ - {:mix_test_watch, "~> 0.2.6", only: [:dev, :test]} + {:ex_doc, "~> 0.13.0", only: [:dev]}, + {:mix_test_watch, "~> 0.2.6", only: [:dev, :test]}, + ] + end + + defp package do + [ + name: :boltex, + files: ~w(lib README.md LICENSE), + build_tools: [:hex], + maintainers: ["Michael Schaefermeyer"], + licenses: ["Apache 2.0"], + links: %{ + "GitHub" => "https://github.com/mschae/boltex", + "Docs" => "https://hexdocs.pm/boltex" + } ] end end @@ -1,4 +1,6 @@ %{"connection": {:hex, :connection, "1.0.3", "3145f7416be3df248a4935f24e3221dc467c1e3a158d62015b35bd54da365786", [:mix], []}, "db_connection": {:hex, :db_connection, "1.0.0-rc.3", "d9ceb670fe300271140af46d357b669983cd16bc0d01206d7d3222dde56cf038", [:mix], [{:sbroker, "~> 1.0.0-beta.3", [hex: :sbroker, optional: true]}, {:poolboy, "~> 1.5", [hex: :poolboy, optional: true]}, {:connection, "~> 1.0.2", [hex: :connection, optional: false]}]}, + "earmark": {:hex, :earmark, "1.0.1", "2c2cd903bfdc3de3f189bd9a8d4569a075b88a8981ded9a0d95672f6e2b63141", [:mix], []}, + "ex_doc": {:hex, :ex_doc, "0.13.0", "aa2f8fe4c6136a2f7cfc0a7e06805f82530e91df00e2bff4b4362002b43ada65", [:mix], [{:earmark, "~> 1.0", [hex: :earmark, optional: false]}]}, "fs": {:hex, :fs, "0.9.2", "ed17036c26c3f70ac49781ed9220a50c36775c6ca2cf8182d123b6566e49ec59", [:rebar], []}, "mix_test_watch": {:hex, :mix_test_watch, "0.2.6", "9fcc2b1b89d1594c4a8300959c19d50da2f0ff13642c8f681692a6e507f92cab", [:mix], [{:fs, "~> 0.9.1", [hex: :fs, optional: false]}]}} |