Permalink
Browse files

Pretty readme to show off features

  • Loading branch information...
soffes committed Jan 14, 2011
1 parent 4d6189b commit 571ae6eb1e6aeb9e1797dc16d6a71dc0e08695ea
Showing with 47 additions and 4 deletions.
  1. +0 −4 README
  2. +47 −0 Readme.markdown
View
4 README
@@ -1,4 +0,0 @@
-This project aims to duplicate the methods present on Mac OSX which allow creation of NSAttributedString
- from HTML code on iOS.
-
-This is useful for drawing simple rich text like any HTML document without having to use a UIWebView.
View
@@ -0,0 +1,47 @@
+# NSAttributedString HTML Additions
+
+This project aims to duplicate the methods present on Mac OSX which allow creation of `NSAttributedString` from HTML code on iOS.
+
+This is useful for drawing simple rich text like any HTML document without having to use a `UIWebView`.
+
+## Features
+
+At present the following tags are supported:
+
+* Headers H1 - H6
+* Paragraphs: P
+* Bold: B, STRONG
+* Italic: I, EM
+* Underline: U
+* Superscript: SUP
+* Subscript: SUB, e.g. e = mc<sup>2</sup>
+* Styling: FONT (face and color, not size). It would be great if we could support many more styles
+* Unordered Lists: UL, LI
+* Ordered Lists: OL, LI
+
+Currently attributes are inherited by enclosed tags via 'brute force'. I don't know if this is accurate.
+
+## To Do
+
+### NSAttributedString+HTML
+
+* Decode HTML Entities
+* A HREF tags, to format links
+* More styles, as far as supported by CoreText
+
+### DTAttributedTextView
+
+* Run Delegate: make room for IMG and draw the IMG
+* Run Delegate: Characters with super/subscript need baseline adjusted when drawn
+* Caret Positioning
+* Hit Detection on strings attributed with HREF
+* Text Insertion
+* Editing!
+
+There is still quite a few more things to do on the project. DEL, possibly CSS styles as they related to fonts and text formatting.
+
+## Please Help!
+
+If you find brief test cases where the created `NSAttributedString` differs from the version on OSX please send them to us!
+
+Follow [@cocoanetics](http://twitter.com/cocoanetics) on Twitter.

0 comments on commit 571ae6e

Please sign in to comment.