From 13ffcde3d9df9b173c9c211d8f85e6add13ee3a4 Mon Sep 17 00:00:00 2001 From: Atlas Sullivan Date: Thu, 2 May 2019 13:02:01 +0100 Subject: [PATCH] Update and rename README.txt to README.md Converted to markdown --- README.txt => README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) rename README.txt => README.md (91%) diff --git a/README.txt b/README.md similarity index 91% rename from README.txt rename to README.md index 808bf43..17dada6 100644 --- a/README.txt +++ b/README.md @@ -1,12 +1,13 @@ superators - by Jay Phillips - http://jicksta.com +========== -== DESCRIPTION: +by Jay Phillips http://jicksta.com + +## DESCRIPTION: Superators are a superset of new Ruby operators you can create and use. -== FEATURES/PROBLEMS: +## FEATURES/PROBLEMS: * Presently a superator operand must support having a singleton class. Because true, false, nil, Symbols, and Fixnums are all specially optimized for in MRI and cannot have singleton classes, they can't be given to a superator. There are ways this can be potentially accounted for, but nothing is in place at the moment, causing this to be classified as a bug. @@ -14,7 +15,7 @@ Superators are a superset of new Ruby operators you can create and use. * Superators work by handling a binary Ruby operator specially and then building a chain of unary operators after it. For this reason, a superator must match the regexp /^(\*\*|\*|\/|%|\+|\-|<<|>>|&|\||\^|<=>|>=|<=|<|>|===|==|=~)(\-|~|\+)+$/. -== SYNOPSIS: +## SYNOPSIS: Below is a simple example monkey patch which adds the "<---" operator to all Ruby Arrays. @@ -28,17 +29,17 @@ Below is a simple example monkey patch which adds the "<---" operator to all Rub end end -== REQUIREMENTS: +## REQUIREMENTS: * Only requirement is Ruby. -== INSTALL: +## INSTALL: * sudo gem install superators * require 'superators' -== LICENSE: +## LICENSE: This software is licensed in the public domain. You may do whatever you wish with it. -You are allowed to use this library during dodo poaching as well. \ No newline at end of file +You are allowed to use this library during dodo poaching as well.