UNPKG

@candle-so/node

Version:

A library for interacting with the Candle API

41 lines (24 loc) 902 B
# @candle-so/node A library for interacting with the Candle API. ## Installation To install the SDK, use npm or yarn: ```sh npm install @candle-so/node ``` or ```sh yarn add @candle-so/node ``` ## Usage ### Initialization First, you need to initialize the Candle SDK with your API key: ```typescript import Candle from "@candle-so/node"; const candle = Candle.init({ api_key: process.env.CANDLE_API_KEY }); ``` ## Contributing We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details. ``` This README provides a comprehensive guide to using your package, including installation instructions, usage examples for each endpoint, and sections for contributing and licensing. Make sure to adjust any placeholders or specific details to match your project.