@digitalculture/ochre-sdk 0.1.19

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Forum for Digital Culture - University of Chicago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# OCHRE SDK
+
+A JavaScript/TypeScript SDK for working with OCHRE (Online Cultural and Historical Research Environment) data.
+
+## Installation
+
+```bash
+pnpm add @uchicago/ochre
+or
+npm install @uchicago/ochre
+or
+bun install @uchicago/ochre
+```
+
+## Features
+
+- Type-safe parsing of OCHRE data structures
+- Comprehensive TypeScript types for OCHRE entities
+- Utilities for handling OCHRE websites, resources, and metadata
+- Support for parsing rich text, documents, and multilingual content
+
+## Usage
+
+```typescript
+import { fetchWebsite, fetchResource, fetchSet } from "@uchicago/ochre";
+
+// Fetch and parse OCHRE website data
+const website = await fetchWebsite(abbreviation);
+
+// Fetch and parse OCHRE resource data
+const resource = await fetchResource(uuid);
+
+// Fetch and parse OCHRE set data
+const set = await fetchSet(uuid);
+```
+
+## API Reference
+
+### Core Functions
+
+#### `fetchWebsite(abbreviation: string): Promise<Website | null>`
+
+Fetch and parse OCHRE website data.
+
+```typescript
+const website = await fetchWebsite("guerrilla-television");
+```
+
+#### `fetchResource(uuid: string): Promise<Resource | null>`
+
+Fetch and parse OCHRE resource data.
+
+```typescript
+const resource = await fetchResource("27adf18a-21ad-442b-b186-0c7f3b8cb2d1");
+```
+
+### Types
+
+The SDK provides comprehensive TypeScript types for OCHRE data structures. Key types include:
+
+- `Website` - Represents an OCHRE website
+- `Resource` - Represents an OCHRE resource
+- `Set` - Represents an OCHRE set
+- `Document` - Represents an OCHRE MDX document
+- `WebElement` - Represents a web element in an OCHRE website
+- And many more...
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+[MIT](LICENSE)