Skip to content

Commit 491e4db

Browse files
committed
Update documentation
1 parent 5f25652 commit 491e4db

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# This is a fork!!!
2+
3+
This library stands on the shoulders of the original [docx](https://github.com/chrahunt/docx) -- it is my hope that @chrahunt will pull the changes I've incorporated into this library back into his original library.
4+
5+
This library depends on the latest version of rubyzip and incorporates changes from these two pull requests:
6+
* [Paragraph alignment, text run font sizes, and HTML output](https://github.com/chrahunt/docx/pull/13) from @higginsdragon
7+
* [File replacement within document](https://github.com/chrahunt/docx/pull/18) from @tmikoss
8+
19
# docx
210

311
a ruby library/gem for interacting with `.docx` files. currently capabilities include reading paragraphs/bookmarks, inserting text at bookmarks, reading tables/rows/columns/cells and saving the document.
@@ -6,7 +14,7 @@ a ruby library/gem for interacting with `.docx` files. currently capabilities in
614

715
### install
816

9-
requires ruby (only tested with 1.9.3 so far)
17+
requires ruby (tested with 2.1.1)
1018

1119
gem install docx
1220

@@ -99,7 +107,6 @@ p_child = p_element.at_xpath("//child::*") # selects first child
99107

100108
### todo
101109

102-
* Add better formatting identification for specific nodes and other formatting indicators (text size, paragraph spacing)
103110
* Calculate element formatting based on values present in element properties as well as properties inherited from parents
104111
* Default formatting of inserted elements to inherited values
105112
* Implement formattable elements.

docx.gemspec

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
66
s.version = Docx::VERSION
77
s.summary = 'a ruby library/gem for interacting with .docx files'
88
s.description = s.summary
9-
s.authors = ['Christopher Hunt', 'Marcus Ortiz']
10-
s.email = ['chrahunt@gmail.com']
11-
s.homepage = 'https://github.com/chrahunt/docx'
9+
s.authors = ['Christopher Hunt', 'Marcus Ortiz', 'Higgins Dragon', 'Toms Mikoss', 'Sebastian Wittenkamp']
10+
s.email = ['sebastian@bitops.io']
11+
s.homepage = 'https://github.com/bitops/docx'
1212
s.files = Dir["README.md", "LICENSE.md", "lib/**/*.rb"]
1313

1414
s.add_dependency 'nokogiri', '~> 1.5'

0 commit comments

Comments
 (0)