Permalink
Browse files

Updated README.

  • Loading branch information...
1 parent d2b471d commit b4c44674eafbc05cdb913ba27317543df27af56b @wayneeseguin wayneeseguin committed Nov 11, 2011
Showing with 10 additions and 5 deletions.
  1. +10 −5 README.md
View
@@ -6,18 +6,20 @@ usage for all Module APIs exposed to Extension Developers.
Each extension within the set contains examples for the commands provided by the
corresponding API.
-In order to install the set to be able to use the examples,
+In order to be able to use these examples, install this repository as an SM
+Framework extension:
sm ext install apidoc https://github.com/sm/sm_apidoc
-Once you have installed the set you can then proceed to show examples for a
-specific API command run that API command prefixed with sm.
+Once you have installed the apidoc extension you can then proceed to run
+examples for a specific API command run that API command prefixed with sm.
-Let's say that we want to know details about the 'array each' API command call,
+As an example, let's say that we want to know details about the 'array each'
+API command call,
sm apidoc array each
-Will display the examples for the array each api.
+This will display the examples / tutorial for the array each api.
To see all api commands documented for 'array' api,
@@ -27,3 +29,6 @@ For descriptions,
sm man apidoc array
+Note that the apidocs are a work in progress and not yet complete.
+Currently {array,files,paths} are the most complete apidocs.
+

0 comments on commit b4c4467

Please sign in to comment.