Cyrene

A modern TypeScript library.

Installation

npm install cyrene
# or
pnpm add cyrene
# or
yarn add cyrene

Usage

import { Cyrene, createCyrene } from 'cyrene';

// Create instance
const cyrene = new Cyrene({
  debug: true,
  version: '1.0.0'
});

// Or use factory function
const cyrene2 = createCyrene({ debug: false });

// Use the library
console.log(cyrene.greet('World')); // "Hello, World! Welcome to Cyrene."
console.log(cyrene.getVersion()); // "1.0.0"
console.log(cyrene.isDebugMode()); // true

API

new Cyrene(options?)

Creates a new Cyrene instance.

Options

• debug?: boolean - Enable debug mode (default: false)
• version?: string - Set version (default: '1.0.0')

createCyrene(options?)

Factory function to create a new Cyrene instance.

Methods

• getVersion(): string - Get the current version
• isDebugMode(): boolean - Check if debug mode is enabled
• log(message: string): void - Log a message if debug mode is enabled
• greet(name: string): string - A sample utility function

Development

# Install dependencies
pnpm install

# Build the library
pnpm run build

# Run tests
pnpm run test

# Lint code
pnpm run lint

# Fix linting issues
pnpm run lint:fix

License

MIT