mirror of
https://github.com/logos-messaging/OpChan.git
synced 2026-01-24 15:23:07 +00:00
cca6299eb5
* chore: move to /app * chore: setup workspace * chore: move lib * wip * fix: build and memory leak * fix: app content hydration for message manager * fix: non-ens wallets engagement, syncing hydration * chore: improvements * chore: IdentityContext * chore: time range for sds store query to 1 month * chore: remove client prop * remove env logs * wip * FIX HYDRATION * fix: message signing * chore: rename providers * fix: hydration interface * state consistentcy * fix: ens * chore: minimal docs * chore: update readme * local build
72 lines
874 B
Markdown
72 lines
874 B
Markdown
# Opchan
|
|
|
|
A TypeScript browser library workspace.
|
|
|
|
## Structure
|
|
|
|
This is an npm workspace containing:
|
|
|
|
- `@opchan/core` - Core browser library package
|
|
|
|
## Development
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Building
|
|
|
|
Build all packages:
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
Build specific package:
|
|
```bash
|
|
npm run build --workspace=@opchan/core
|
|
```
|
|
|
|
### Development Mode
|
|
|
|
Watch mode for development:
|
|
```bash
|
|
npm run dev --workspace=@opchan/core
|
|
```
|
|
|
|
### 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 |