ruby_html 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -16
  3. data/lib/ruby_html/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8cf10da42b2a32aff7c67a58f3a8d0483d1b754c0df61ed073069006a4817478
4
- data.tar.gz: 2fdc6c6b4168d6afba39009d17010604645d3dfe66af2caac8b36f7ec06b0ca1
3
+ metadata.gz: e4875574430eb91491d8bc9df2596a672b27f7af4c64d69cf346846e2da34bff
4
+ data.tar.gz: 53e7cd3caafb6d3c7494f2ffc41460a620548d3c40768ab167d0dcd513bb0819
5
5
  SHA512:
6
- metadata.gz: 5c7be02af205f74dca18f915dcf984e986bda08013bca8ba3a3f4365c02c5cadf66e295eb5c5c00bd8ebb3fa32d81279f824116991ecb4382a3fe9d984b52763
7
- data.tar.gz: 415fccbcc1c9ddd93962209db002c48bc81f1a80bf7156c03ddbf3bcc5d10163908e29612bee9fd664c147cb6fa99a75fb302be9a5208871720c391425e6766c
6
+ metadata.gz: dc3efe40d2695bda6044721fc28e6d20fb2818f841c3fab757fae165d0d22fc3fe3166140e765a1622547bd803fe5e5a6e3cbffe51fc32f5aca6e755f4e45e86
7
+ data.tar.gz: d84b875bf71c100fd786bb150e0427ada92bb85455178cfcf9212db38308914039f599d00e132457120b5983249a12cbfca8e9a99157e2becc587e4681945036
data/README.md CHANGED
@@ -1,24 +1,26 @@
1
1
  # Ruby HTML
2
2
 
3
- A (totally unnecessary) HTML document builder in Ruby.
3
+ An HTML document builder in Ruby.
4
4
 
5
5
  ### Installation
6
6
 
7
- Eventually, this will be a gem, but for now you can do:
7
+ Add this line to your application's Gemfile:
8
8
 
9
+ ```ruby
10
+ gem "ruby_html"
9
11
  ```
10
- git clone https://github.com/jonathanwthom/ruby_html.git
11
- cd rhtml
12
- irb
13
- require_relative "ruby_html"
14
- ```
15
12
 
16
- Or you can include the rhtml directory in a project, and
17
- require it there.
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install ruby_html
18
20
 
19
21
  ### How to Use It
20
22
 
21
- HTML element classes have the names you think they would. For example, to create a div:
23
+ HTML elements have the names you think they would. For example, to create a div:
22
24
 
23
25
  ```
24
26
  div = Div.new
@@ -65,7 +67,7 @@ title = Title.new("Page Title")
65
67
  Document.new(Div.new, header_elements: [title])
66
68
  ```
67
69
 
68
- `Document` has a special method, `#render_to_file` that recieves a file path, and creates your html document there.
70
+ `Document` has a special method, `#render_to_file` that receives a file path, and creates your html document there.
69
71
 
70
72
  ```
71
73
  Document.new.render_to_file("hello_world.html")
@@ -75,11 +77,10 @@ Document.new.render_to_file("hello_world.html")
75
77
 
76
78
  ### TODO
77
79
 
78
- So much!
79
-
80
- - Build out all other elements. See the current list of supported elements [here](https://github.com/JonathanWThom/rhtml/blob/master/elements/elements.rb).
81
- - Tests!
82
- - Gemify it.
80
+ - Build out remaining elements. There are a few that conflict with ruby (such as `Object`).
81
+ - Code clean up (alphabetical order, some methods probably don't need to be public, etc).
82
+ - The single quotes for attributes are a bit weird, and you might not always want those.
83
+ - It desperately needs some tests!
83
84
 
84
85
  ### Contributing
85
86
 
@@ -1,3 +1,3 @@
1
1
  module RubyHtml
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby_html
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonathan Thom