Skip to content

Commit

Permalink
docs(shape): Add link to API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ghaiklor committed Dec 14, 2015
1 parent 3a23ef8 commit f8adf3d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

work
build
docs
examples
src
test
pids
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ Import module and extend another one:
import Shape from 'kittik-shape-basic';

export default class Rectangle extends Shape {
constructor(...args) {
super(...args);
}

render(cursor) {
cursor.write('Hello');
// Other logic for rendering the shape
}
}
```

## API

For API documentation take a closer look into [Basic.md](docs/Basic.md) file.

## License

The MIT License (MIT)
Expand Down
1 change: 1 addition & 0 deletions src/Basic.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export default class Shape {
* @param {Number} [options.y] Absolute coordinate Y
* @param {String} [options.background] Background color from {@link COLORS}
* @param {String} [options.foreground] Foreground color from {@link COLORS}
* @param {String} [options.align] Set if shape is need to be aligned
* @param {Object} [options.animation] Animation options for this shape
*/
constructor(options = {}) {
Expand Down

0 comments on commit f8adf3d

Please sign in to comment.