Permalink
Browse files

add a README and CHANGELOG

  • Loading branch information...
1 parent d78bb38 commit 7701e641b8fa762d75f6b44394a4a928e95cde67 @yob yob committed Jan 27, 2011
Showing with 42 additions and 1 deletion.
  1. +2 −0 CHANGELOG
  2. +39 −0 README.rdoc
  3. +1 −1 ttfunk.gemspec
View
@@ -0,0 +1,2 @@
+v1.0.0 (XX February 2011)
+* initial release as a standalone gem
View
@@ -0,0 +1,39 @@
+TTFunk is a TrueType font parser written in pure ruby.
+
+= Installation
+
+The recommended installation method is via Rubygems.
+
+ gem install ttfunk
+
+= Usage
+
+Basic usage:
+
+ require 'ttfunk'
+
+ file = TTFunk::File.open("some/path/myfont.ttf")
+ puts "name : #{file.name.font_name.join(', ')}"
+ puts "ascent : #{file.ascent}"
+ puts "descent : #{file.descent}"
+
+For more detailed examples, explore the examples directory.
+
+= Maintainers
+
+- Brad Ediger
+- Daniel Nelson
+- Jonathen Green
+- James Healy
+
+= Licensing
+
+??
+
+= Mailing List
+
+TTFunk is maintaiend as a dependency of prawn, the ruby PDF generation library.
+
+Any questions or feedback should be sent to the Prawn google group.
+
+http://groups.google.com/group/prawn-ruby
View
@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
spec.summary = "TrueType Font Metrics Parser"
spec.description = "Get Ya TrueType Funk On! (Font Metrics Parser for Prawn)"
- spec.files = Dir.glob("{lib,data}/**/*") + ['example.rb']
+ spec.files = Dir.glob("{lib,data}/**/*") + ['example.rb','CHANGELOG','README.rdoc']
spec.required_ruby_version = '>= 1.8.7'
spec.required_rubygems_version = ">= 1.3.6"

0 comments on commit 7701e64

Please sign in to comment.