Skip to content

Commit

Permalink
Add readme notes on recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
fenomas committed Oct 6, 2016
1 parent b354c8c commit 9884e55
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ inverseY: true,
})
```

### Docs

The source is pretty fully commented. There is a partial API reference
at the end of this file, but I haven't been able to find a good way of
generating JSDocs that I can live with, so for now it's best to consult
the source.

### Recent changes:

* 0.18.0
* Simplifies block targeting. Instead of several accessor methods, now there's a persistent `noa.targetedBlock` with details on whatever block is currently targeted.
* `noa` now emits `targetBlockChanged`
* Built-in block highlighting can now be overridden or turned off with option `skipDefaultHighlighting`
* 0.17.0
* Adds per-block callbacks: `onCreate`, `onDestroy`, `onCustomMeshCreate`
* 0.16.0
* Simplifies block registration - now takes an options argument, and the same API is used for custom mesh blocks
* Removes the idea of registration for meshes

----

## Partial API reference:
Expand Down
20 changes: 20 additions & 0 deletions tools/doctemplate.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,26 @@ var noa = engine({
})
```

### Docs

The source is pretty fully commented. There is a partial API reference
at the end of this file, but I haven't been able to find a good way of
generating JSDocs that I can live with, so for now it's best to consult
the source.


### Recent changes:

* 0.18.0
* Simplifies block targeting. Instead of several accessor methods, now there's a persistent `noa.targetedBlock` with details on whatever block is currently targeted.
* `noa` now emits `targetBlockChanged`
* Built-in block highlighting can now be overridden or turned off with option `skipDefaultHighlighting`
* 0.17.0
* Adds per-block callbacks: `onCreate`, `onDestroy`, `onCustomMeshCreate`
* 0.16.0
* Simplifies block registration - now takes an options argument, and the same API is used for custom mesh blocks
* Removes the idea of registration for meshes

----

## Partial API reference:
Expand Down

0 comments on commit 9884e55

Please sign in to comment.