Permalink
Browse files

don't force edown installation in prod. fix #10

  • Loading branch information...
1 parent 674355b commit 245d9252ecc0a6355a39c87d559bb52714fe00aa @benoitc committed Oct 24, 2012
Showing with 82 additions and 59 deletions.
  1. +16 −2 Makefile
  2. +24 −15 README.md
  3. +9 −0 doc/README.md
  4. +0 −33 doc/hackney_pool_sup.md
  5. +10 −0 doc/overview.edoc
  6. +2 −9 rebar.config
  7. +21 −0 rebar_dev.config
View
18 Makefile
@@ -2,8 +2,10 @@ REBAR?=./rebar
all: build
-doc:
- $(REBAR) doc
+dev: devbuild
+
+doc: devclean dev
+ $(REBAR) -C rebar_dev.config doc
clean:
$(REBAR) clean
@@ -18,4 +20,16 @@ deps:
$(REBAR) get-deps
+# development
+#
+devclean:
+ $(REBAR) -C rebar_dev.config clean
+
+devbuild: devdeps
+ $(REBAR) -C rebar_dev.config compile
+
+devdeps:
+ $(REBAR) -C rebar_dev.config get-deps
+
+
.PHONY: doc deps
View
39 README.md
@@ -126,6 +126,8 @@ hackney helps you send different payload by passing different terms as
the request body:
- `{form, PropList}` : To send a form
+- `{multipart, KVs}` : to send you body using the multipart API. KVs can
+ be under the form `{file, Name, Content}` or `Value`
- `{file, File}` : To send a file
- Bin: To send a binary or an iolist
@@ -227,23 +229,30 @@ option `{proxy, ProxyUrl}` where `ProxyUrl` can be a simple url or an
For issues, comments or feedback please [create an
issue](http://github.com/benoitc/hackney/issues).
+### Notes for developer
+
+If you want to contribute patches or improve the doc, you will need to
+build hackney using the `rebar_dev.config` file. It can also be built
+using the **Makefile**:<pre>$ make dev ; # compile & get deps
+$ make devclean ; # clean all files</pre>
+
##Modules##
<table width="100%" border="0" summary="list of modules">
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney.md" class="module">hackney</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_app.md" class="module">hackney_app</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_deps.md" class="module">hackney_deps</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_form.md" class="module">hackney_form</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_headers.md" class="module">hackney_headers</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_pool.md" class="module">hackney_pool</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_request.md" class="module">hackney_request</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_response.md" class="module">hackney_response</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_ssl_transport.md" class="module">hackney_ssl_transport</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_sup.md" class="module">hackney_sup</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_tcp_transport.md" class="module">hackney_tcp_transport</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_transform.md" class="module">hackney_transform</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_url.md" class="module">hackney_url</a></td></tr>
-<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.0/doc/hackney_util.md" class="module">hackney_util</a></td></tr></table>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney.md" class="module">hackney</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_app.md" class="module">hackney_app</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_deps.md" class="module">hackney_deps</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_form.md" class="module">hackney_form</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_headers.md" class="module">hackney_headers</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_multipart.md" class="module">hackney_multipart</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_pool.md" class="module">hackney_pool</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_request.md" class="module">hackney_request</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_response.md" class="module">hackney_response</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_ssl_transport.md" class="module">hackney_ssl_transport</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_sup.md" class="module">hackney_sup</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_tcp_transport.md" class="module">hackney_tcp_transport</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_transform.md" class="module">hackney_transform</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_url.md" class="module">hackney_url</a></td></tr>
+<tr><td><a href="http://github.com/benoitc/hackney/blob/0.3.1/doc/hackney_util.md" class="module">hackney_util</a></td></tr></table>
View
9 doc/README.md
@@ -126,6 +126,8 @@ hackney helps you send different payload by passing different terms as
the request body:
- `{form, PropList}` : To send a form
+- `{multipart, KVs}` : to send you body using the multipart API. KVs can
+ be under the form `{file, Name, Content}` or `Value`
- `{file, File}` : To send a file
- Bin: To send a binary or an iolist
@@ -227,6 +229,13 @@ option `{proxy, ProxyUrl}` where `ProxyUrl` can be a simple url or an
For issues, comments or feedback please [create an
issue](http://github.com/benoitc/hackney/issues).
+### Notes for developer
+
+If you want to contribute patches or improve the doc, you will need to
+build hackney using the `rebar_dev.config` file. It can also be built
+using the **Makefile**:<pre>$ make dev ; # compile & get deps
+$ make devclean ; # clean all files</pre>
+
##Modules##
View
33 doc/hackney_pool_sup.md
@@ -1,33 +0,0 @@
-
-
-#Module hackney_pool_sup#
-* [Function Index](#index)
-* [Function Details](#functions)
-
-
-__Behaviours:__ [`supervisor`](supervisor.md).<a name="index"></a>
-
-##Function Index##
-
-
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr><tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr></table>
-
-
-<a name="functions"></a>
-
-##Function Details##
-
-<a name="init-1"></a>
-
-###init/1##
-
-
-`init(X1) -> any()`
-
-<a name="start_link-0"></a>
-
-###start_link/0##
-
-
-`start_link() -> any()`
-
View
10 doc/overview.edoc
@@ -311,6 +311,16 @@ option `{proxy, ProxyUrl}' where `ProxyUrl' can be a simple url or an
For issues, comments or feedback please [create an
issue](http://github.com/benoitc/hackney/issues).
+### Notes for developers
+
+If you want to contribute patches or improve the doc, you will need to
+build hackney using the `rebar_dev.config' file. It can also be built
+using the **Makefile**:
+
+```
+$ make dev ; # compile & get deps
+$ make devclean ; # clean all files
+'''
@end
View
11 rebar.config
@@ -10,13 +10,6 @@
{clean_files, ["*~","*/*~","*/*.xfm","test/*.beam"]}.
{deps, [
- {mimetypes, ".*", {git, "https://github.com/spawngrid/mimetypes.git",
- "master"}},
- {edown, ".*",
- {git, "git://github.com/esl/edown.git", "HEAD"}}
+ {mimetypes, ".*", {git, "https://github.com/spawngrid/mimetypes.git",
+ "master"}}
]}.
-
-
-{edoc_opts, [{doclet, edown_doclet},
- {top_level_readme,
- {"./README.md", "http://github.com/benoitc/hackney"}}]}.
View
21 rebar_dev.config
@@ -0,0 +1,21 @@
+%% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ft=erlang ts=4 sw=4 et
+
+{erl_opts, [debug_info]}.
+{xref_checks, [undefined_function_calls]}.
+
+{cover_enabled, true}.
+{eunit_opts, [verbose]}.
+
+{clean_files, ["*~","*/*~","*/*.xfm","test/*.beam"]}.
+
+{deps, [
+ {mimetypes, ".*", {git, "https://github.com/spawngrid/mimetypes.git",
+ "master"}},
+ {edown, ".*",
+ {git, "git://github.com/esl/edown.git", "HEAD"}}
+]}.
+
+{edoc_opts, [{doclet, edown_doclet},
+ {top_level_readme,
+ {"./README.md", "http://github.com/benoitc/hackney"}}]}.

0 comments on commit 245d925

Please sign in to comment.