Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adding version file as well as update to readme

  • Loading branch information...
commit 4a25d1ee6e6bacf903e30a55ce2ab11f26514a0a 1 parent f9d2b18
@mikel authored
Showing with 28 additions and 13 deletions.
  1. +1 −0  .gitignore
  2. +20 −10 README.rdoc
  3. +2 −2 lib/mail/version.rb
  4. +5 −1 mail.gemspec
View
1  .gitignore
@@ -1,3 +1,4 @@
.DS_Store
coverage
rdoc
+gems
View
30 README.rdoc
@@ -29,6 +29,7 @@ you are doing, you can fiddle with every last bit of your email directly.
* RFC2045-2049 Support for multipart emails
* Support for creating multipart alternate emails
* Support for reading multipart/report emails & getting details from such
+* Support for multibyte emails - needs quite a lot of work and testing
* Wrappers for File, Net/POP3, Net/SMTP
Mail is RFC2822 compliant now, that is, it can parse and generate valid US-ASCII
@@ -48,9 +49,8 @@ and you can manually create any other type of MIME email.
Next TODO:
-* Add multilingual MIME support for non US-ASCII headers
+* Add multilingual MIME support for mixed ASCII and multibyte headers
* Add IMAP wrapper
-* Release Mail as a Gem and bask in it's glitter
== Testing Policy
@@ -64,23 +64,33 @@ It also means you can be sure Mail will behave correctly.
== API Policy
-Right now Mail is still under development for a 1.0 release.
+Right now Mail is still under development for a 1.0.0 release.
-The API will change between now and 1.0. How much? Not sure. Basically though
-once 1.0 is released, no API removals within a single point release. All removals
+The API will change between now and 1.0.0. How much? Not sure. Basically though
+once 1.0.0 is released, no API removals within a single point release. All removals
to be depreciated with warnings for at least one point release before removal.
Also, all private or protected methods to be declared as such.
== Installation
-If you are using this in production right now, you must _really_ know
-what you are doing. This is well spec'd and tested alpha code.
+Installation is fairly simple, I host mail on gemcutter, so you can just do:
-If you need instructions beyond "go get it from my git repo" then you
-probably shouldn't be playing with Mail yet. Wait till I've wrapped it
-up into a gem.
+ # gem install mail
+if you are on gemcutter, if you aren't, you can by doing:
+
+ # gem install gemcutter
+ # gem tumble
+ # gem install mail
+
+Warning though, the above will change your first gem repository to gemcutter, this
+may or may not be a problem for you.
+
+If you want to install mail manually, you can download the gem from github and do:
+
+ # gem install mail-1.0.0.gem
+
== Contributing
Please do! Contributing is easy in Mail:
View
4 lib/mail/version.rb
@@ -1,9 +1,9 @@
# encoding: utf-8
module Mail
module VERSION
- MAJOR = 0
+ MAJOR = 1
MINOR = 0
- TINY = 1
+ TINY = 0
STRING = [MAJOR, MINOR, TINY].join('.')
end
View
6 mail.gemspec
@@ -3,7 +3,7 @@ MAIL_ROOT = File.dirname(__FILE__)
Gem::Specification.new do |s|
s.name = %q{mail}
- s.version = "0.0.1"
+ s.version = "1.0.0"
s.requirements << 'treetop, Treetop is a Ruby-based DSL for text parsing and interpretation'
s.requirements << 'mime/types, A list of a lot of Mime Types'
@@ -23,9 +23,13 @@ Gem::Specification.new do |s|
s.extra_rdoc_files = [
"README.rdoc"
]
+
+ # I like knowing what goes into my gem... Manifest.txt is only ever edited
+ # by hand
s.files = File.read(File.join(MAIL_ROOT, 'Manifest.txt')).lines.map do |f|
File.join(MAIL_ROOT, f.chomp)
end
+
s.homepage = %q{http://github.com/mikel/mail}
s.rdoc_options = ["--charset=UTF-8"]
s.require_paths = ["lib"]

0 comments on commit 4a25d1e

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