Geo-2D
Geo-2D is a TypeScript library designed to handle various 2-dimensional geometric operations. It provides a set of tools to create, manipulate, and analyze 2D shapes, lines, curves, and other geometric constructs efficiently and accurately.
Table of Contents
Features
- Curve Object: include line-curve, quadratic-curve adn bezier-curve.
- Shape Operations: Work with basic shapes like singleShape, and polygons.
- Transformations: Apply transformations like translation, rotation, and scaling to geometric objects.
Installation
You can install geo-2d
using npm:
npm install geo-2d
yarn add geo-2d
pnpm add geo-2d
Usage
Below is a simple example of how to use geo-2d in a TypeScript project:
API Reference
Examples
Contributing
Contributions are welcome! Please see our CONTRIBUTING.md for more information.
Fork the repository.
Create a new branch (git checkout -b feature/your-feature).
Commit your changes (git commit -am 'Add your feature').
Push to the branch (git push origin feature/your-feature).
Create a new Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to customize this template based on the specific functionality and requirements of your geo-2d
project. You can also expand on the API reference section and add more examples or documentation links as your project grows.