Update readme with example picture & golang port reference

gabzim / circle-to-polygon

Receives a Coordinate, a Radius and a Number of edges and aproximates a circle by creating a polygon that fills its area

ISC License

113 stars 29 forks source link

Update readme with example picture & golang port reference #48

Closed johachi closed 2 years ago

johachi commented 2 years ago

Description

Add an example image
Update the example to be code that creates the polygon shown in the example image. This is also the same parameters used by the go/golang port
This closes #46

gabzim commented 2 years ago

Something we could add @johachi is an .npmignore file to make sure the image does not become a part of the npm package in future versions. That way we don't increase the size of the package in case somebody's using this on the front end.

johachi commented 2 years ago

Something we could add @johachi is an .npmignore file to make sure the image does not become a part of the npm package in future versions. That way we don't increase the size of the package in case somebody's using this on the front end.

@gabzim , I didn't think about that. I added one now and included the image and all test files (*specs.js). Looks good?

gabzim commented 2 years ago

Looks good! Merge away!