Skip to content

Commit 06efca0

Browse files
committed
Renamed README.md to README.rst and began writing documentation.
1 parent 356a261 commit 06efca0

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

README.md

-2
This file was deleted.

README.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
===========
2+
Encapsulate
3+
===========
4+
5+
A JavaScript OO system
6+
7+
8+
Contents
9+
========
10+
11+
1. Introduction
12+
2. Requirements
13+
3. Usage
14+
4. Tests
15+
16+
17+
Introduction
18+
============
19+
20+
Encapsulate is a compact OO system for JavaScript that allows you to easily
21+
create object instantiators (You probably know these as classes) using a
22+
combination of traits (Objects or functions providing members) and other
23+
instantiators (You probably call this inheritance).
24+
25+
Encapsulate is similar to StampIt_ in many regards and `Ring.js`_ in others.
26+
27+
Much like StampIt_, Encapsulate allows you to construct instances using factory
28+
functions that can easily be re-used by multiple instantiators (StampIt_ calls
29+
these stamps).
30+
31+
Similar to `Ring.js`_, Encapsulate allows you to re-use your instantiators
32+
(`Ring.js`_ calls these classes) for inheritance purposes. As with `Ring.js`_,
33+
Encapsulate makes use of `C3 Linearization`_ to implemented a well-behaved
34+
multiple-inheritance scheme.
35+
36+
.. _StampIt: https://github.com/stampit-org/stampit
37+
.. _Ring.js: http://ringjs.neoname.eu/
38+
.. _C3 Linearization: https://en.wikipedia.org/wiki/C3_linearization

0 commit comments

Comments
 (0)