Skip to content
Browse files

License clarification and documentation cleanup

  • Loading branch information...
1 parent 090c7cf commit fbeb5f9b64cf626757ba6022a2818e7b30459cce @alexdunae alexdunae committed Jan 24, 2011
Showing with 22 additions and 46 deletions.
  1. +2 −1 .gitignore
  2. +6 −37 LICENSE.rdoc
  3. +6 −6 README.rdoc
  4. +1 −2 lib/premailer/html_to_plain_text.rb
  5. +7 −0 rakefile.rb
View
3 .gitignore
@@ -1,3 +1,4 @@
.DS_Store
*.html
-*.gem
+*.gem
+html/
View
43 LICENSE.rdoc
@@ -1,42 +1,11 @@
= Premailer License
-Copyright (c) 2007-09 Alex Dunae
+Copyright (c) 2007-2011, Alex Dunae. All rights reserved.
-Premailer is copyrighted free software by Alex Dunae (http://dunae.ca/).
-You can redistribute it and/or modify it under the conditions below:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- 1. You may make and give away verbatim copies of the source form of the
- software without restriction, provided that you duplicate all of the
- original copyright notices and associated disclaimers.
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Premailer, Alex Dunae nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
- 2. You may modify your copy of the software in any way, provided that
- you do at least ONE of the following:
-
- a) place your modifications in the Public Domain or otherwise
- make them Freely Available, such as by posting said
- modifications to the internet or an equivalent medium, or by
- allowing the author to include your modifications in the software.
-
- b) use the modified software only within your corporation or
- organization.
-
- c) rename any non-standard executables so the names do not conflict
- with standard executables, which must also be provided.
-
- d) make other distribution arrangements with the author.
-
- 3. You may modify and include the part of the software into any other
- software (possibly commercial) as long as clear acknowledgement and
- a link back to the original software (http://code.dunae.ca/premailer.web/)
- is provided.
-
- 5. The scripts and library files supplied as input to or produced as
- output from the software do not automatically fall under the
- copyright of the software, but belong to whomever generated them,
- and may be sold commercially, and may be aggregated with this
- software.
-
- 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
- IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- PURPOSE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
12 README.rdoc
@@ -18,7 +18,7 @@ script is my solution.
=== Installation
-Download the Premailer gem from GemCutter.
+Download the Premailer gem from RubyGems.
sudo gem install premailer
@@ -42,7 +42,7 @@ Download the Premailer gem from GemCutter.
=== Contributions
-Contributions are most welcome. Premailer was rotting away in a private SVN repository for too long and could use some TLC. Pull and patch to your heart's content.
+Contributions are most welcome. Premailer was rotting away in a private SVN repository for too long and could use some TLC. Fork and patch to your heart's content. Please don't increment the version numbers, though.
A few areas that are particularly in need of love:
* Testing suite
@@ -54,13 +54,13 @@ A few areas that are particularly in need of love:
=== Credits and code
-Thanks to {all the wonderful contributors}[http://github.com/alexdunae/premailer/contributors] for their updates.
+Thanks to {all the wonderful contributors}[https://github.com/alexdunae/premailer/contributors] for their updates.
Thanks to {Greenhood + Company}[http://www.greenhood.com/] for sponsoring some of the 1.5.6 updates,
and to {Campaign Monitor}[http://www.campaignmonitor.com] for supporting the web interface.
-The web interface can be found at http://premailer.dialect.ca .
+The web interface can be found at {premailer.dialect.ca}[http://premailer.dialect.ca].
-The source code can be found at http://github.com/alexdunae/premailer .
+The source code can be found on {GitHub}[https://github.com/alexdunae/premailer].
-Written by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2008-2010.
+Copyright by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-2011. See LICENSE.rdoc for license details.git co
View
3 lib/premailer/html_to_plain_text.rb
@@ -6,8 +6,7 @@ module HtmlToPlainText
# Returns the text in UTF-8 format with all HTML tags removed
#
- # TODO:
- # - add support for DL, OL
+ # TODO: add support for DL, OL
def convert_to_text(html, line_length = 65, from_charset = 'UTF-8')
txt = html
View
7 rakefile.rb
@@ -2,6 +2,7 @@
require 'rake'
require 'rake/testtask'
+require 'rake/rdoctask'
require 'fileutils'
require 'premailer'
@@ -48,3 +49,9 @@
t.test_files = FileList['test/test_*.rb']
t.verbose = false
end
+
+Rake::RDocTask.new do |rd|
+ rd.main = "README.rdoc"
+ rd.rdoc_files.include("README.rdoc", "LICENSE.rdoc", "lib/**/*.rb")
+ rd.title = 'Premailer Documentation'
+end

0 comments on commit fbeb5f9

Please sign in to comment.
Something went wrong with that request. Please try again.