readem 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +9 -73
- data/lib/readem/version.rb +1 -1
- data/readem.gemspec +1 -1
- metadata +2 -2
data/README.md
CHANGED
|
@@ -1,86 +1,22 @@
|
|
|
1
1
|
# An amazing tool renders readmes in realtime
|
|
2
2
|
|
|
3
3
|
Assuming I have all my projects in the ~/Projects directory, we can
|
|
4
|
-
start a web server on port
|
|
4
|
+
start a web server on port 1337 which renders a list of projects which have a README.
|
|
5
5
|
|
|
6
6
|
When I want to serve up all my readmes, I enter this at the terminal:
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
```
|
|
9
|
+
gem install readem
|
|
10
|
+
readem
|
|
11
|
+
```
|
|
10
12
|
|
|
11
13
|
Then my browser will automagically open the URL http://localhost:1337/
|
|
12
14
|
and view a list of links to projects.
|
|
13
15
|
|
|
14
16
|
When I click one of the links, the readme for that repository is
|
|
15
|
-
displayed.
|
|
16
|
-
editing, so I can view my changes in "realtime".
|
|
17
|
-
|
|
18
|
-
## Implementation notes
|
|
19
|
-
|
|
20
|
-
Rendering markdown: use the Makeup gem.
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
17
|
+
displayed.
|
|
38
18
|
|
|
19
|
+
## Not yet true
|
|
39
20
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
## Implementation notes
|
|
52
|
-
|
|
53
|
-
### Directories with readmes
|
|
54
|
-
require "pathname"
|
|
55
|
-
readmes = Pathname.glob("/home/marius/Projects/*/README.md")
|
|
56
|
-
readme_dirs = readmes.map(&:dirname)
|
|
57
|
-
local_dirnames = readme_dirs.map(&:dirname)
|
|
58
|
-
|
|
59
|
-
### Mark up Markdown
|
|
60
|
-
|
|
61
|
-
There's this thing called Makeup. How does it work? Use the
|
|
62
|
-
[README](http://gitorious.org/gitorious/makeup), stupid.
|
|
63
|
-
|
|
64
|
-
require "makeup/markup"
|
|
65
|
-
first_readme = readmes.first
|
|
66
|
-
first_readme = Makeup::Markup.new.render(first_readme.basename.to_s, first_readme.read)
|
|
67
|
-
|
|
68
|
-
- Sinatra
|
|
69
|
-
- List each readme
|
|
70
|
-
- get /project-name: render readme
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
### Bootstrap boilerplate
|
|
74
|
-
<!DOCTYPE html>
|
|
75
|
-
<html>
|
|
76
|
-
<head>
|
|
77
|
-
<link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
|
|
78
|
-
<title>Zomg</title>
|
|
79
|
-
</head>
|
|
80
|
-
<body>
|
|
81
|
-
<div class="container">
|
|
82
|
-
<h1>Amazing</h1>
|
|
83
|
-
<code>Oh</code>
|
|
84
|
-
</div>
|
|
85
|
-
</body>
|
|
86
|
-
</html>
|
|
21
|
+
Then it reloads the readme every 3 seconds after I stop
|
|
22
|
+
editing, so I can view my changes in "realtime".
|
data/lib/readem/version.rb
CHANGED
data/readem.gemspec
CHANGED
|
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
|
|
|
10
10
|
spec.email = ["marius.mathiesen@gmail.com"]
|
|
11
11
|
spec.description = %q{Serve the READMEs in your ~/Projects in a web browser}
|
|
12
12
|
spec.summary = %q{Run it, and see all your READMEs.}
|
|
13
|
-
spec.homepage = ""
|
|
13
|
+
spec.homepage = "https://github.com/zmalltalker/readem"
|
|
14
14
|
spec.license = "MIT"
|
|
15
15
|
|
|
16
16
|
spec.files = `git ls-files`.split($/)
|
metadata
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: readem
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
4
|
prerelease:
|
|
5
|
-
version: 0.1.
|
|
5
|
+
version: 0.1.3
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
8
8
|
- Marius Mathiesen
|
|
@@ -108,7 +108,7 @@ files:
|
|
|
108
108
|
- views/index.erb
|
|
109
109
|
- views/layout.erb
|
|
110
110
|
- views/readme.erb
|
|
111
|
-
homepage:
|
|
111
|
+
homepage: https://github.com/zmalltalker/readem
|
|
112
112
|
licenses:
|
|
113
113
|
- MIT
|
|
114
114
|
post_install_message:
|