Skip to content

Commit

Permalink
misc(readme): updated readme with demo link
Browse files Browse the repository at this point in the history
  • Loading branch information
MD4 committed Dec 2, 2020
1 parent 7731149 commit 287f22a
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# shadowed
Dead simple shadow casting computation.

[Demo here](https://md4.github.io/shadowed)

[![License](https://badgen.net/github/license/MD4/shadowed)](./LICENSE)
[![Library minified size](https://badgen.net/bundlephobia/min/shadowed)](https://bundlephobia.com/result?p=shadowed)
[![Library minified + gzipped size](https://badgen.net/bundlephobia/minzip/shadowed)](https://bundlephobia.com/result?p=shadowed)
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

`Const`**computeShadows**(`bounds`: [Bounds](interfaces/bounds.md), `walls`: [Segment2](interfaces/segment2.md)[], `light`: [Vec2](interfaces/vec2.md)): [Vec2](interfaces/vec2.md)[][]

*Defined in [computeShadows.ts:39](https://github.com/MD4/shadowed/blob/22036b8/src/computeShadows.ts#L39)*
*Defined in [computeShadows.ts:39](https://github.com/MD4/shadowed/blob/7731149/src/computeShadows.ts#L39)*

Computes casted shadows by a light for a given set of walls within specified bounds.

Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/bounds.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@

**bottomRight**: [Vec2](vec2.md)

*Defined in [entities.ts:8](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L8)*
*Defined in [entities.ts:8](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L8)*

___

### topLeft

**topLeft**: [Vec2](vec2.md)

*Defined in [entities.ts:7](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L7)*
*Defined in [entities.ts:7](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L7)*
4 changes: 2 additions & 2 deletions docs/interfaces/segment2.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@

**a**: [Vec2](vec2.md)

*Defined in [entities.ts:12](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L12)*
*Defined in [entities.ts:12](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L12)*

___

### b

**b**: [Vec2](vec2.md)

*Defined in [entities.ts:13](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L13)*
*Defined in [entities.ts:13](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L13)*
4 changes: 2 additions & 2 deletions docs/interfaces/vec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@

**x**: number

*Defined in [entities.ts:2](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L2)*
*Defined in [entities.ts:2](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L2)*

___

### y

**y**: number

*Defined in [entities.ts:3](https://github.com/MD4/shadowed/blob/22036b8/src/entities.ts#L3)*
*Defined in [entities.ts:3](https://github.com/MD4/shadowed/blob/7731149/src/entities.ts#L3)*

0 comments on commit 287f22a

Please sign in to comment.