SAMPLE_README.md

DESCRIBE THE LIBRARY

LINK TO OTHER RESOURCES

This library allows you to quickly and easily do @todo via Node.js.

This project is not officially affiliated with @todo, it's maintained by community members. For any feedback, questions or issues, please create issues and pull requests or merely upvote or comment on existing issues or pull requests.

Table of Contents

• Table of Contents
• Installation
  • Prerequisites
  • Obtain an API Key
  • Setup Environment Variables
  • Install Package
• Quick Start, Create a Draft
• Roadmap
• Contributing
  • Requirements
  • Setup
  • npm scripts
• About
  • Acknowledgments
• LICENSE

Installation

Prerequisites

• Node.js version 10 or 12

Obtain an API Key

Grab your API Key from the @todo.

Setup Environment Variables

Do not hardcode your API Key into your code. Instead, use an environment variable or some other secure means of protecting your API Key. Following is an example of using an environment variable.

Update the development environment with your @todo, for example:

Install Package

The following recommended installation requires npm. If you are unfamiliar with npm, see the npm docs. Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it.

npm install --save @todo

You may also use [npm run](https://npm runpkg.com/en/) to install.

npm run add @todo

Quick Start, Create a Draft

The following is the minimum needed code to use this library. Use this example, and modify the to and from variables:

For more complex use cases, please see USE_CASES.md.

Roadmap

If you are interested in the future direction of this project, please take a look at the open issues and pull requests. I would love to hear your feedback!

Contributing

Requirements

• Node 18
• npm v7

Setup

1. Clone the repository
2. Run npm install installs all required dependencies.
3. Run npm run build to build from TypeScript to common JavaScript distribution formats.
4. Run npm run test to run all tests.

npm scripts

Equivalent npm run <script> should also work

• npm run test run tests against built output with ava. Important: runs against build output so run npm run build beforehand.
• npm run build run build from TypeScript to UMD, CJS, ESM with microbundle
• npm run watch runs build in watch mode with microbundle
• npm run lint will lint all of the files with xo
• npm run format will run lint with --fix option on all the examples files (and tests).
• npm run release, run clean, production build and release with np.

About

This package is maintained by Hugo from Code with Hugo and Alpine.js Weekly.

Acknowledgments

Special thanks to:

• The developers behind
  • microbundle
  • np
  • microbundle-ts-pkg template

LICENSE

Code is licensed under the MIT License.