Skip to content

Commit 66eb0ae

Browse files
authored
Merge pull request #7 from linux-nerd/feature/add-details-in-readme
Added content to readme file and resized the logo
2 parents b16c074 + f96f430 commit 66eb0ae

File tree

2 files changed

+50
-2
lines changed

2 files changed

+50
-2
lines changed

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,51 @@
1-
![Data Structures Logo](logo.jpg?raw=true "Title")
1+
![Data Structures Logo](logo-small.jpg?raw=true "Title")
2+
3+
4+
Data Structures in Javascript
5+
-----------------------------
6+
7+
# Background
8+
There are neither a lot of resources on internet nor any book which guides and dictates best practices in the implementation of popular Data Structures using Javascript. The purpose of this library is to provide cooked implementation of populare data structures in javascript.
9+
10+
# Getting hands dirty
11+
Clone the repo
12+
```git clone https://github.com/linux-nerd/data-structures.js.git```
13+
14+
Install the dependencies
15+
```npm install```
16+
17+
Run dev build
18+
```npm run dev```
19+
20+
To execute unit test cases
21+
```npm test```
22+
23+
Trigger production build
24+
```npm run build```
25+
26+
# List of Data Structures
27+
Data structures covered so far -
28+
- [Binary Search Tree](https://github.com/linux-nerd/data-structures.js/wiki/Binary-Search-Tree)
29+
30+
# Contribution
31+
Your contribution is highly appreciated. You can contribute in several ways -
32+
* Opening an issue in the tracker
33+
* Updating and adding documentaion
34+
* Adding new features
35+
* Adding demo
36+
37+
# Vision
38+
Once development is complete. This library will work in -
39+
* All supported Browsers
40+
* Node
41+
42+
and can be written in -
43+
* es5
44+
* es6
45+
* typescript
46+
47+
and will be published in
48+
- npm
49+
- bower
50+
251

3-
# Commonly used data structures

logo-small.jpg

14.2 KB
Loading

0 commit comments

Comments
 (0)