Skip to content

Commit e0e0cf3

Browse files
author
Bishop92
committed
Wrote the readme
1 parent 652c3e9 commit e0e0cf3

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
[Data Structures](https://github.com/Bishop92/JavaScript-Data-Structures)
2+
=================
3+
**A library for data structures in JavaScript**
4+
5+
DataStructures is a JavaScript library where you can find the most common data structures and also other data
6+
structures more advanced. Various method are also provided in order to manipulate data structures.
7+
8+
This library implements also the [iterator] (http://en.wikipedia.org/wiki/Iterator_pattern) pattern in order to hide
9+
the data structure that work for storing your data.
10+
11+
Supported data structures
12+
-------------------------
13+
- [Stack]
14+
- [Queue]
15+
- [Priority Queue]
16+
- [Circular Buffer]
17+
- [Hash Table]
18+
- [Linked List]
19+
- [Double Linked List]
20+
- [Binary Search Tree]
21+
- [Red-Black Tree]
22+
- [Red-Black Tree List]
23+
- [B-Tree]
24+
- [Set]
25+
26+
How to use
27+
----------
28+
1. Download the minimized library [here](https://github
29+
.com/Bishop92/JavaScript-Data-Structures/blob/master/DataStructuresMinimized.js);
30+
31+
2. Include the file in your project;
32+
33+
3. Start to use it as any other class.
34+
35+
Example
36+
37+
```JavaScript
38+
var listA = new DoubleLinkedList();
39+
var listB = new DoubleLinkedList();
40+
listA.fromArray([0, 1]);
41+
listB.fromArray([2, 3]);
42+
listA.join(listB);
43+
listA.toArray(); // [0, 1, 2, 3]
44+
```
45+
46+
Documentation
47+
-------------
48+
Follow this link to read the full documentation.
49+
50+
History
51+
-------
52+
53+
### Future implementations
54+
55+
- Persistence for data structures like array and lists.
56+
57+
### Current state of the art
58+
- v 1.0.0 First release of the library.
59+
60+
Support
61+
-------
62+
Battistella Stefano, [stefano.battistella.92@gmail.com](mailto:stefano.battistella.92@gmail.com)

0 commit comments

Comments
 (0)