schemadoc 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -16
- data/lib/schemadoc/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: 1553b53e3a36358bec955a1337ba6102519cd27c
|
|
4
|
+
data.tar.gz: a5823bc3dcfe55e9bd3a1b915506f6618eb6d861
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a398a5d569589f70a2f4dbc9e048cee0bf8a0e23691205079c1ae643a9f8eb4ca621fea422cd559b559a26907ceb356ae54091a56cda8ceef6bf036bd53d25b9
|
|
7
|
+
data.tar.gz: 05da390bad8d767bb38bad26bd7d8ec60a239b6c1b72ddd0c2248d7cb291f57a034a04d415c4634624e237847b5fc2a9e4ce4f950d36cec7cd1de469a3aebcf0
|
data/README.md
CHANGED
|
@@ -8,6 +8,7 @@ schemadoc gem - document your database schemas (tables, columns, etc.)
|
|
|
8
8
|
* rdoc :: [rubydoc.info/gems/schemadoc](http://rubydoc.info/gems/schemadoc)
|
|
9
9
|
|
|
10
10
|
|
|
11
|
+
|
|
11
12
|
## Usage Command Line
|
|
12
13
|
|
|
13
14
|
The `schemadoc` gem includes a command line tool
|
|
@@ -86,20 +87,9 @@ world:
|
|
|
86
87
|
- names
|
|
87
88
|
- langs
|
|
88
89
|
- usages
|
|
89
|
-
|
|
90
|
-
## support tables
|
|
91
|
-
|
|
92
|
-
support:
|
|
93
|
-
name: Support
|
|
94
|
-
tables:
|
|
95
|
-
- logs
|
|
96
|
-
- props
|
|
97
|
-
- tags
|
|
98
|
-
- taggings
|
|
99
90
|
~~~
|
|
100
91
|
|
|
101
92
|
|
|
102
|
-
|
|
103
93
|
## Outputs
|
|
104
94
|
|
|
105
95
|
The `schemadoc` tool writes out two json files:
|
|
@@ -108,6 +98,16 @@ The `schemadoc` tool writes out two json files:
|
|
|
108
98
|
- `symbols.json` - includes all symbols from a to z
|
|
109
99
|
|
|
110
100
|
|
|
101
|
+
**Examples.**
|
|
102
|
+
See the football.db -
|
|
103
|
+
[`database.json`](https://github.com/openfootball/schema/blob/gh-pages/_data/database.json),
|
|
104
|
+
[`symbols.json`](https://github.com/openfootball/schema/blob/gh-pages/_data/symbols.json)
|
|
105
|
+
or beer.db -
|
|
106
|
+
[`database.json`](https://github.com/openbeer/schema/blob/gh-pages/_data/database.json),
|
|
107
|
+
[`symbols.json`](https://github.com/openbeer/schema/blob/gh-pages/_data/symbols.json)
|
|
108
|
+
live examples.
|
|
109
|
+
|
|
110
|
+
|
|
111
111
|
## Reports 'n' Templates
|
|
112
112
|
|
|
113
113
|
To generate web pages from you json files use a static site generator and
|
|
@@ -115,6 +115,14 @@ a template pack (theme). For example, to use the `book-templates/schema` theme
|
|
|
115
115
|
copy your json files in the `_data/` folder and rebuild the site (e.g. $ `jekyll build`).
|
|
116
116
|
That's it. Enjoy your database schema docu.
|
|
117
117
|
|
|
118
|
+
**Examples.**
|
|
119
|
+
See the [football.db](http://openfootball.github.io/schema/)
|
|
120
|
+
or [beer.db](http://openbeer.github.io/schema/) live examples.
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
## Free Schemadoc Template Packs / Themes
|
|
124
|
+
|
|
125
|
+
- [`book-templates/schema`](https://github.com/book-templates/schema) - free schemadoc theme; works w/ Jekyll (and GitHub Pages) static site generator
|
|
118
126
|
|
|
119
127
|
|
|
120
128
|
## Install
|
|
@@ -126,11 +134,6 @@ $ gem install schemadoc
|
|
|
126
134
|
~~~
|
|
127
135
|
|
|
128
136
|
|
|
129
|
-
## Free Schemadoc Template Packs / Themes
|
|
130
|
-
|
|
131
|
-
- [`book-templates/schema`](https://github.com/book-templates/schema) - free schemadoc theme; works w/ Jekyll (and GitHub Pages) static site generator
|
|
132
|
-
|
|
133
|
-
|
|
134
137
|
## License
|
|
135
138
|
|
|
136
139
|
The `schemadoc` scripts are dedicated to the public domain.
|
data/lib/schemadoc/version.rb
CHANGED