Package Exports
- artifyjs
- artifyjs/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (artifyjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Artisfy
Artisfy is a Node.js module that allows you to create customized images with text overlays and various effects.
Installation
To use Artisfy, you need to install Node.js and the required dependencies:
npm install canvas fs
Usage
You can use Artisfy by importing the createImage function and providing the necessary options:
const createImage = require('./createImage');
// Example options
const options = {
width: 800,
height: 600,
text: 'Hello, World!',
outputPath: 'output.png',
bgImagePath: 'background.jpg',
blur: true,
};
// Create the image
createImage(options, program);
Options
width: Width of the output image.
height: Height of the output image.
text: Text to be displayed on the image.
outputPath: Path where the generated image will be saved.
bgImagePath: Path to the background image.
blur: Boolean flag indicating whether to apply a blur effect to the background image.
Contributing
Contributions to Artisfy are welcome! Feel free to open issues or submit pull requests.
License
This project is licensed under the MIT License - see the LICENSE file for details.
You can copy this content and save it as README.md in your text editor. Let me know if you need any further assistance!