mirror of
https://github.com/trycua/computer.git
synced 2026-02-22 14:29:26 -06:00
Rewrite TypeScript README in the format of the Python README
This commit is contained in:
@@ -1,22 +1,47 @@
|
||||
# Cua Core TypeScript Library
|
||||
<div align="center">
|
||||
<h1>
|
||||
<div class="image-wrapper" style="display: inline-block;">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" alt="logo" height="150" srcset="https://raw.githubusercontent.com/trycua/cua/main/img/logo_white.png" style="display: block; margin: auto;">
|
||||
<source media="(prefers-color-scheme: light)" alt="logo" height="150" srcset="https://raw.githubusercontent.com/trycua/cua/main/img/logo_black.png" style="display: block; margin: auto;">
|
||||
<img alt="Shows my svg">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
The core cua library with support for telemetry and other utilities.
|
||||
[](#)
|
||||
[](#)
|
||||
[](https://discord.com/invite/mVnXXpdE85)
|
||||
[](https://www.npmjs.com/package/@trycua/core)
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
**Cua Core** provides essential shared functionality and utilities used across the Cua ecosystem:
|
||||
|
||||
- Privacy-focused telemetry system for transparent usage analytics
|
||||
- Common helper functions and utilities used by other Cua packages
|
||||
- Core infrastructure components shared between modules
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pnpm install @trycua/core
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
- Install dependencies:
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
- Run the unit tests:
|
||||
Run the unit tests:
|
||||
|
||||
```bash
|
||||
pnpm test
|
||||
```
|
||||
|
||||
- Build the library:
|
||||
Build the library:
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
|
||||
Reference in New Issue
Block a user