thesis-js

@thesis/core

A template for easy library creation.

Contents

1. The Why
2. Installation
3. Getting Started
   • 3.1. Basic Usage
4. API Documentation
5. Contributing

The Why

Installation

• Installation: npm i lib-template
• CDN:
  • AMD module: https://unpkg.com/lib-template@0.0.0/dist/index.amd.js
  • CommonJS module: https://unpkg.com/lib-template@0.0.0/dist/index.cjs.js
  • EcmaScript module: https://unpkg.com/lib-template@0.0.0/dist/index.esm.js

Getting Started

Basic Usage

API Documentation

For further information please refer to API Documentation.

Contributing

When contributing to Automatons, please open an issue first.

Please note the code of conduct, it is desired to follow it in all your interactions with the project.

Reporting Bugs

When reporting a bug, please provide a minimal case of reproduction, which can be:

• a test that is broken but should not be,
• a Codesandbox project in which the bug occurs.

Pull Request Process

When sending a pull request, please do not forget the following:

• resolve all conflicts with master branch,
• update the README.md and/or the documentation in comments according to your changes,
• ensure the documentation build is up-to-date in docs folder,
• ensure the new functionality is covered by tests, and all tests pass.