Merge branch 'develop' of https://github.com/engineering87/SharpConnector into develop

Author: engineering87

README.md

@@ -11,14 +11,31 @@
 
 SharpConnector is a .NET library designed to streamline integration with NoSQL databases. It provides a unified interface that simplifies database operations, eliminating the need to develop custom logic for each specific database connector. Since each NoSQL database has its own unique characteristics, such as being document-oriented or key-value-based, SharpConnector abstracts these differences, providing a consistent and simplified access layer to accelerate development.
 
+✅ Now targeting .NET 9.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+  - [How it works](#how-it-works)
+  - [How to use it](#how-to-use-it)
+- [API Overview](#api-overview)
+- [Contributing](#contributing)
+- [Extending](#extending)
+- [License](#license)
+- [External References](#external-references)
+- [Contact](#contact)
+
 ## Features
 
-- Unified interface for CRUD operations across various NoSQL databases.
-- Supports key-value stores (Redis, EnyimMemcached, DynbamoDb) and document-oriented databases (MongoDB, LiteDB, RavenDB, Couchbase).
-- Facilitates streamlined database operations without the need for custom connectors.
-- Simplified integration using configuration files and dependency injection.
-- Easy integration for various payload types.
-- Allows extension with new connectors by implementing the IOperations interface.
+- A single, generic client API for CRUD across multiple NoSQL engines
+- Supported stores:
+	- Key–value: Redis, EnyimMemcached, DynamoDb
+	- Document: MongoDB, LiteDB, RavenDB, Couchbase
+	- Multi-model: ArangoDB
+- Simple configuration via `appsettings.json` and DI-friendly
+- Sync and async operations (with CancellationToken support)
+- Easy to extend: implement `IOperations<T>` for new connectors
 
 ## Installation
 
@@ -38,7 +55,7 @@ Through SharpConnector, you can use a consistent interface to perform Insert, Ge
 * **EnyimMemcached (key-value)**
 * **RavenDB (document-oriented)**
 * **Couchbase (document-oriented)**
-* **DynbamoDb (key-value or document-oriented)**
+* **DynamoDb (key-value or document-oriented)**
 * **ArangoDB (multi-model)**
 
 SharpConnector thus simplifies the development process, providing flexibility and compatibility across diverse NoSQL paradigms without the need to handle specific database implementations.
@@ -114,7 +131,7 @@ Then, add the specif `ConnectorConfig` node within your *appsettings.json* file:
 	}
 	```
 
-- DynbamoDb
+- DynamoDb
 	```json
 	{
 	  "ConnectorConfig": {
@@ -156,23 +173,48 @@ builder.Services.AddSharpConnectorServices<string>();
 ```
 This setup provides flexibility in working with different payload types and makes SharpConnector easy to use within dependency injection configurations.
 
-### Contributing
-Thank you for considering to help out with the source code!
-If you'd like to contribute, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.
-If you want to add new connectors, please follow these three rules: 
-
-1) Each new connector must implement the **IOperations** interface.
-2) For each new connector the relevant **UnitTest** class must be present.
-3) Any third party libraries added in the code must be compatible with the MIT license, and the license must also be made explicit in the code.
-
- * [Setting up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
- * [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
- * [Open an issue](https://github.com/engineering87/SharpConnector/issues) if you encounter a bug or have a suggestion for improvements/features
-
-### License
+## API Overview
+The main entry point is the generic `ISharpConnectorClient<T>`:
+- `T Get(string key)`
+- `Task<T> GetAsync(string key, CancellationToken ct = default)`
+- `IEnumerable<T> GetAll()`
+- `Task<IEnumerable<T>> GetAllAsync(CancellationToken ct = default)`
+- `bool Insert(string key, T value)`
+- `bool Insert(string key, T value, TimeSpan expiration)`
+- `Task<bool> InsertAsync(string key, T value, CancellationToken ct = default)`
+- `Task<bool> InsertAsync(string key, T value, TimeSpan expiration, CancellationToken ct = default)`
+- `bool InsertMany(Dictionary<string,T> values)`
+- `bool InsertMany(Dictionary<string,T> values, TimeSpan expiration)`
+- `Task<bool> InsertManyAsync(IEnumerable<T> values, CancellationToken ct = default)`
+- `bool Update(string key, T value)`
+- `Task<bool> UpdateAsync(string key, T value, CancellationToken ct = default)`
+- `bool Delete(string key)`
+- `Task<bool> DeleteAsync(string key, CancellationToken ct = default)`
+- `bool Exists(string key)`
+- `Task<bool> ExistsAsync(string key, CancellationToken ct = default)`
+- `IEnumerable<T> Query(Func<T,bool> filter)`
+- `Task<IEnumerable<T>> QueryAsync(Func<T,bool> filter, CancellationToken ct = default)`
+
+## Contributing
+Thanks for considering a contribution! Please fork, branch, and open a PR.
+- Add unit tests for new features or connectors
+- Keep third-party dependencies compatible with MIT and document their licenses
+- Useful links:
+	- [Setting up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
+	- [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
+	- [Open an issue](https://github.com/engineering87/SharpConnector/issues) if you encounter a bug or have a suggestion for improvements/features
+
+## Extending
+To add a new connector:
+- Implement `IOperations<T>` for your backend.
+- Provide a wrapper/access layer (connection management, collection/table handles).
+- Add configuration binding under ConnectorConfig.
+- Include unit tests.
+
+## License
 SharpConnector source code is available under MIT License, see license in the source.
 
-#### External References
+### External References
 The SharpConnector library relies on several third-party libraries to deliver advanced functionality. 
 Each of these libraries operates under a specific license, which governs its usage. To ensure transparency and compliance, the libraries and their licenses are listed in this repository:
 
@@ -187,5 +229,5 @@ Each of these libraries operates under a specific license, which governs its usa
 
 Each library is included to enhance the functionality of SharpConnector while adhering to its licensing terms.
 
-### Contact
-Please contact at francesco.delre[at]protonmail.com for any details.
+## Contact
+Please contact at francesco.delre[at]protonmail.com for any details.