@sinequa/atomic 0.0.62 → 0.0.100

package/README.md

@@ -1,18 +1,67 @@
-# atomic
-This is a package created to practice building a TypeScript package with Vite.
+# @sinequa/atomic
 
-## How to publish a new version
-* first commit your changes
-* build a new version (the version number will be incremented)
+![npm](https://img.shields.io/npm/v/atomic.svg)
+![license](https://img.shields.io/npm/l/atomic.svg)
 
+A modern TypeScript package designed for use with [Sinequa](https://www.sinequa.com/), providing web API helpers, authentication, configurations, and utilities.
+
+---
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [License](#license)
+
+---
+
+## Features
+
+- **Web API Helpers**: Simplify API calls with helpers for aggregations, datasets, preview, principal, query, and more.
+- **Authentication**: Easy-to-use authentication utilities (OAuth, SAML, JWT, CSRF, etc.).
+- **Configurations**: Centralized and type-safe configuration management.
+- **Helpers & Utilities**: Includes bisect, date, logger, syslang, and more.
+- **Type Definitions**: Strongly-typed interfaces for API endpoints and data structures.
+- ...and many more functions to help you build with Sinequa.
+
+Explore the full feature set in the [online documentation](https://sinequa.github.io/sba-mint/atomic/intro).
+
+---
+
+## Installation
+
+```sh
+npm install @sinequa/atomic
 ```
-npm run build:patch
-```
 
+---
+
+## Usage
+
+Import and use helpers in your TypeScript project:
 
-* commit the changes (then new version number)
-* publish the package to verdaccio
+```ts
+import { fetchQuery, fetchAggregation, isAuthenticated } from '@sinequa/atomic';
 
+// Example: Fetch data
+const data = await fetchQuery({ query: 'example' });
+
+// Example: Check authentication
+if (isAuthenticated()) {
+  // ...
+}
 ```
-npm run v:publish
-```
+
+---
+
+## Documentation
+
+Comprehensive documentation is available in the [Atomic Documentation Portal](https://sinequa.github.io/sba-mint/atomic/intro).
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.