Add installation, usage, and API documentation to README.md - #1
Open
johnhenry wants to merge 1 commit into
Open
Conversation
* **Installation**: Add instructions for installing the library using npm. * **Usage**: Add a simple example demonstrating how to use the library. * **API Documentation**: Add documentation for the `Character` class and its methods. * **Comprehensive Example**: Add a comprehensive example demonstrating the `Character` class. Add tests for `Character` class in `tests/character.test.js` * Import `Character` class from `src/index.ts`. * Add tests for `Character.fromFile` method with JSON, PNG, and WEBP files. * Add tests for `Character` class properties and methods.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Characterclass and its methods.Characterclass.Add tests for
Characterclass intests/character.test.jsCharacterclass fromsrc/index.ts.Character.fromFilemethod with JSON, PNG, and WEBP files.Characterclass properties and methods.