README.rdoc in wparser-0.0.1 vs README.rdoc in wparser-0.0.2
- old
+ new
@@ -2,27 +2,30 @@
* http://github.com/#{github_username}/#{project_name}
== DESCRIPTION:
-FIX (describe your package)
+This package is Wiki Format Parser.
+Wiki => html
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
== SYNOPSIS:
- FIX (code sample of usage)
+require 'wparser'
+parser = WParser.parser.new
+parser.parse(text)
+
== REQUIREMENTS:
* FIX (list of requirements)
== INSTALL:
-* FIX (sudo gem install, anything else)
+gem install wparser
== LICENSE:
(The MIT License)
@@ -43,6 +46,6 @@
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.