documentary 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +12 -0
- data/lib/documentary/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f25bb931fb9ce91753bde54f114a19362fbe8c46
|
|
4
|
+
data.tar.gz: 50e7f9a59d248706bb4d6267da0d76d06f3d0931
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 82a11e37442205e9b68dd19c769768b499ba4f5248ef613a0eb1ad56d06463609d5d5e7b3a459a0292ab66475292cf79b52c4aa4b5dc9ffd35ee1068cb6cbb93
|
|
7
|
+
data.tar.gz: 799ad9bdff0459e89d134597cdb60f553be337a6c5544581c0a11c2cd8bce704b57cb8332ea1231dcea4c41d1251cf400a34222caea8ba579889b9fc906c8693
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -20,6 +20,18 @@ Or in your Gemfile:
|
|
|
20
20
|
gem 'documentary'
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
Documentary ships with a command line runner
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Usage: documentary [options]
|
|
29
|
+
-v, --version Print version number
|
|
30
|
+
-d, --directory glob Set directory to search for docblocks
|
|
31
|
+
-p, --project project Set project name
|
|
32
|
+
-o, --output output Set the output file
|
|
33
|
+
```
|
|
34
|
+
|
|
23
35
|
## Specification
|
|
24
36
|
|
|
25
37
|
Documentary works using good old fashioned docblocks. I believe documentation for APIs should live with the code they document. Creating a documentary docblock is as simple as
|
data/lib/documentary/version.rb
CHANGED