readme fix and minor other fixes

README.md

@@ -2,3 +2,50 @@ diversity-api
 =============
 
 An erlang diversity api server
+
+Configuration
+-------------
+
+Before compiling you need to configure where the git repos should be cloned to, the credentials to diversity.io and
+what port to use for the api server. This is currently done in the `rel/sys.config` file:
+
+``` rel/sys.config
+[{
+    divapi,  [{repo_dir, "path/to/your/directory"},
+              {token, "s3cr3tt0k3n"},
+              {port, 8181}]
+}].
+```
+
+The token can be obtained in your Account settings page on diversity.io (`Profile settings -> Account`)
+
+Building
+--------
+
+`make` - Compiles and builds a release in _rel/divapi_release/
+
+Running
+-------
+
+`./_rel/divapi_release/bin/divapi_release start` - start the server
+`./_rel/divapi_release/bin/divapi_release stop`  - stop the server
+
+
+Usage/Routes
+------------
+
+`/components/<component>/` - Lists all tagged versions of the component
+`/components/` - Lists information of all public components on diversity.io
+`/components/?grouping=sidebar` - Lists all components that have sidebar configured in their grouping attribute.
+
+`/components/<component>/1.2.3/` - diversity.json from component with version 1.2.3
+`/components/<component>/1.2/` - diversity.json from latest patch-version of component 1.2.*
+`/components/<component>/*/` - diversity.json from latest version of the component
+
+`/components/<component>/1.2.3/settings` - settings attribute from the diversity.json from component with version 1.2.3
+`/components/<component>/1.2.3/settingsForm` - settingsForm attribute from the diversity.json from component with version 1.2.3
+`/components/<component>/1.2.3/files/path/to/file.js` - Gets the file file.js
+
+Note: All the version selection methods can be used to get settings, settingsForm and files from the selected version.
+
+

rel/sys.config

@@ -1,4 +1,5 @@
 [{
-    divapi,  [{repo_dir, ""},
-              {token, ""}]
+    divapi,  [{repo_dir, ""}, %% Path to your directory
+              {token, ""},    %% Token from your diversity.io account
+              {port, 8181}]   %% Port to run the server on
 }].

src/component_handler.erl

@@ -61,7 +61,7 @@ handle_get(Req, _State=#state{}) ->
         end,
     {ok, Req4}.
 
-expand_tag(<<"*">>, Tags) -> find_latest_tag(Tags);
+expand_tag(<<"*/">>, Tags) -> find_latest_tag(Tags);
 expand_tag(Tag, Tags) ->
     case lists:member(Tag, Tags) of
         true ->

src/divapi_app.erl

@@ -4,7 +4,6 @@
 -export([start/2]).
 -export([stop/1]).
 
--define(PORT, 8181).
 
 start(_Type, _Args) ->
     inets:start(),
@@ -14,7 +13,8 @@ start(_Type, _Args) ->
     Dispatch = cowboy_router:compile([
         {'_', Routes}
     ]),
-    cowboy:start_http(diversity_api_listener, 100, [{port, ?PORT}],
+    {ok, Port} = application:get_env(divapi, port),
+    cowboy:start_http(diversity_api_listener, 100, [{port, Port}],
         [{env, [{dispatch, Dispatch}]}]
     ),
     divapi_cache:start_link(),

src/git_utils.erl

@@ -55,7 +55,7 @@ get_git_result(RepoName, RepoUrl, Cmd) ->
 
 clone_bare(RepoUrl) ->
     {ok, RepoDir} = application:get_env(divapi, repo_dir),
-    filelib:ensure_dir(RepoDir),
+    filelib:ensure_dir(RepoDir ++ "/"),
     file:set_cwd(RepoDir),
     Cmd = "clone --bare " ++ RepoUrl,
     git_cmd(Cmd).