Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pearmini committed Sep 4, 2023
1 parent bac20d0 commit d838159
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,19 +85,15 @@ If Charming is properly installed, you should get a _lucky clove_ as below 🎉:

## API Reference

### [Creating Application](#creating-application-1)

Rendering app into DOM and animate it.
Rendering app into DOM and animate it:

- [cm.**app**](#cm-app)
- [app.**render**](#app-render)
- [app.**frame**](#app-frame)
- [app.**start**](#app-start)
- [app.**stop**](#app-stop)

### [Setting Attributes](#setting-attributes-1)

Controlling the aesthetic appearance of the shapes.
Controlling the aesthetic appearance of the shapes:

- [app.**scene**](#app-scene) - Sets the specified css _color_ used for the background of the rendering context of the app and returns this app.
- [app.**background**](#app-background) - Sets the specified color (_ch_, _fg_, _bg_) used for the background of the app in cells and returns this app.
Expand All @@ -107,34 +103,26 @@ Controlling the aesthetic appearance of the shapes.
- [app.**noFill**](#app-nofill) - Disables drawing the fill of shapes and returns this app.
- [cm.**wide**](#cm-wide) - Marks the _ch_ as a wide character and returns the marked code point of it.

### [Drawing Shapes](#drawing-shapes-1)

Adding primitives, vertices, and curves to app.
Adding primitives, vertices, and curves to app:

- [app.**point**](#app-point) - Draws a single cell at the specified coordinates (x, y) and returns this app.
- [app.**line**](#app-line) - Draws a straight path from the specified coordinates (_x_, _y_) to coordinates (_x1_, _y1_) and returns this app.
- [app.**rect**](#app-rect) - Draws a rectangle at the specified coordinates (_x_, _y_) with specified _width_ and _height_ and returns this app.
- [app.**pixels**](#app-pixels) - Draws pixels specified by the _render_ function at the specified coordinates (_x_, _y_) and returns this app.

### [Applying Transformations](#applying-transformations-1)

Transforming shapes.
Transforming shapes:

- [app.**translate**](#app-translate)
- [app.**scale**](#app-scale)
- [app.**rotate**](#app-rotate)
- [app.**popMatrix**](#app-popMatrix)
- [app.**pushMatrix**](#app-pushMatrix)

### [Control Flow](#control-flow-1)

A more declarative programming style.
A more declarative programming style:

- [app.**call**](#app-call) - Calls the specified function on this app with any optional arguments and returns this app.

### [Instance Properties](#instance-properties-1)

State of the app.
State of the app:

- [app.**node**](#app-node) - Returns the canvas used to render the app.
- [app.**cols**](#app-cols) - Returns the number of columns in the terminal.
Expand Down

0 comments on commit d838159

Please sign in to comment.