OpChan/README.md

72 lines
874 B
Markdown
Raw Normal View History

# Opchan
A TypeScript browser library workspace.
## Structure
This is an npm workspace containing:
- `@opchan/core` - Core browser library package
## Development
### Installation
2025-08-30 18:34:50 +05:30
```bash
npm install
```
### Building
2025-08-30 18:34:50 +05:30
Build all packages:
```bash
npm run build
```
Build specific package:
```bash
npm run build --workspace=@opchan/core
```
2025-08-30 18:34:50 +05:30
### Development Mode
2025-08-30 18:34:50 +05:30
Watch mode for development:
```bash
npm run dev --workspace=@opchan/core
```
2025-08-30 18:34:50 +05:30
### Testing
```bash
npm test
```
### Linting
```bash
npm run lint
```
## Usage
```typescript
import { Opchan } from '@opchan/core';
const opchan = new Opchan({
debug: true,
version: '1.0.0'
});
console.log(opchan.getVersion()); // "1.0.0"
opchan.log('Hello from Opchan!'); // [Opchan] Hello from Opchan!
```
## Packages
### @opchan/core
The core browser library providing the main functionality.
## License
MIT