Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and rename README.txt to README.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
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.

* When defining a superator in a class, any operators overloaded after the superator definition will override a superator definition. For example, if you create the superator "<---" and then define the <() operator, the superator will not work. In this case, the superator's definition should be somewhere after the <() definition.

* 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.

Expand All @@ -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.
You are allowed to use this library during dodo poaching as well.