Skip to content

Commit

Permalink
fix: Added table of contents to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Guergeiro committed Mar 27, 2021
1 parent b6a3a95 commit a30fbf9
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ An easy way to "Google" your "Map" using search terms.
The name came from that actually. You G**oogle** a **M**ap, giving you
**Moogle**.

## Table of Contents

- [Rationale](#rationale)
- [How It Works](#how-it-works)
- [Guides](#guides)
- [Starting](#starting)
- [Creating the Moogle service](#creating-the-moogle-service)

## Rationale

Everyone likes `Array`! But they come with a problem... If you want to find a
Expand Down Expand Up @@ -78,6 +86,14 @@ In the browser:

In Node:

```
# Using npm
$ npm install @drashland/moogle
# Using yarn
$ yarn add @drashland/moogle
```

```javascript
// JavaScript
const Moogle = require("@drashland/moogle");
Expand All @@ -104,7 +120,9 @@ In Deno:
const service = new Moogle<MyType>();
```

### Creating the Moogle service (using TypeScript)
### Creating the Moogle service

*This uses TypeScript*

1. Instantiate Moogle.

Expand Down

0 comments on commit a30fbf9

Please sign in to comment.