Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinmcfarland committed Aug 6, 2024
1 parent c0b866f commit acb93aa
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

<p align="center">
<a href="https://www.npmjs.com/package/mole"><img src="https://img.shields.io/npm/v/mole.svg"></a>
<a href="https://travis-ci.org/limitlessloop/mole"><img src="https://img.shields.io/travis/limitlessloop/mole.svg"></a>
<a href="https://discord.gg/BDEvF8m"><img src="https://img.shields.io/discord/617327499554193445"></a>
</p>

Expand Down Expand Up @@ -53,8 +52,6 @@ mole.config('src/mole.config.js')

The location of your theme data.

---

- **`model?: string | string[]`**

The value can be:
Expand All @@ -64,8 +61,6 @@ mole.config('src/mole.config.js')

When using a `dir`, it will search for files or sub-directories within that directory whose names match the specified output name.

---

- **`template: string | string[]`**

The value can be:
Expand All @@ -77,8 +72,6 @@ mole.config('src/mole.config.js')

A template can be a callback or a template string.

---

- **`output: object | object[]`**

An object that defines where (`file`) and how (`model`, `template`) to process the output. You can set a different `template` or `model` for each output. Name each output by using a key.
Expand All @@ -93,19 +86,19 @@ mole.config('src/mole.config.js')

## API

- **`mole.config( string | object )`**
- **`mole.config( string | object ): void`**

Set the configuration.

- **`mole.theme( string | object )`**
- **`mole.theme( string | object ): void`**

Set or update the theme data.

- **`mole.register( model: string | template: string, name: string, callback?: function )`**
- **`mole.register( model: string | template: string, name: string, callback?: function ): void`**

Register a model or template for use.

- **`mole.use( model: string | template: string, name, callback? )`**
- **`mole.use( model: string | template: string, name, callback? ): void`**

Use a model or template directory, or use one that has been registered.

Expand Down

0 comments on commit acb93aa

Please sign in to comment.