arvo-core 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -1
- package/README.md +38 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,8 @@
|
|
|
3
3
|
## [1.0.0] - 2024-08-31
|
|
4
4
|
|
|
5
5
|
- Finalised the first release version of the core. This contains core class such as ArvoEvent, ArvoContract, and ArvoContractLibrary. Moreover, this release contains utility functions for string manipulation, validation and OpenTelemetry
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
## [1.0.2] - 2024-08-31
|
|
7
8
|
|
|
8
9
|
- Update ArvoContract description
|
|
9
10
|
|
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
1
3
|
# Arvo
|
|
2
4
|
|
|
3
5
|
## What is Arvo
|
|
@@ -24,10 +26,32 @@ Whether you're building a small microservice or a large-scale distributed system
|
|
|
24
26
|
|
|
25
27
|
This core package defines primitive types and utility functions to help you quickly start building interesting and robust event-driven applications.
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
## Documentation & Resources
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
| Source | Link |
|
|
33
|
+
| --------------- | ------------------------
|
|
34
|
+
| Package | https://www.npmjs.com/package/arvo-core?activeTab=readme |
|
|
35
|
+
| Github | https://github.com/SaadAhmad123/arvo-core |
|
|
36
|
+
| Documenation | https://saadahmad123.github.io/arvo-core/index.html |
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
You can install the core package via `npm` or `yarn`
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npm install arvo-core
|
|
45
|
+
```
|
|
46
|
+
```bash
|
|
47
|
+
yarn add arvo-core
|
|
48
|
+
```
|
|
49
|
+
|
|
28
50
|
|
|
29
51
|
## Components
|
|
30
52
|
|
|
53
|
+
At its core, Arvo has only three main data structures:
|
|
54
|
+
|
|
31
55
|
- [ArvoEvent](src/ArvoEvent/README.md) aims to provide a extendible variant of the open-source CloudEvent spec-ed object to define all the event in the system.
|
|
32
56
|
- [ArvoContract](src/ArvoContract/README.md) is a basic class to define and impose contracts between services, ensuring trust in decoupled systems during build and development.
|
|
33
57
|
- [ArvoContractLibrary](src/ArvoContractLibrary/README.md) is a utility class designed to manage and access multiple ArvoContract instances efficiently.
|
|
@@ -36,13 +60,24 @@ At its core, Arvo has only two main data structures:
|
|
|
36
60
|
|
|
37
61
|
The package also includes utility functions for:
|
|
38
62
|
|
|
39
|
-
- Creating ArvoEvents
|
|
63
|
+
- Creating ArvoEvents, ArvoContracts, and contract libraries
|
|
40
64
|
- Integrating with OpenTelemetry
|
|
41
65
|
- TypeScript types for core components
|
|
42
66
|
|
|
67
|
+
## Getting Started
|
|
68
|
+
|
|
69
|
+
To start using Arvo in your project:
|
|
70
|
+
|
|
71
|
+
- Install the package as shown in the Installation section.
|
|
72
|
+
- Import the necessary components:
|
|
73
|
+
```javascript
|
|
74
|
+
import { createArvoEvent, createArvoContract, createArvoContractLibrary } from 'arvo-core';
|
|
75
|
+
```
|
|
76
|
+
- Begin defining your events and contracts using the provided classes.
|
|
77
|
+
|
|
43
78
|
## License
|
|
44
79
|
|
|
45
80
|
This package is available under the MIT License. For more details, refer to the [LICENSE.md](LICENSE.md) file in the project repository.
|
|
46
81
|
|
|
47
82
|
## Change Logs
|
|
48
|
-
|
|
83
|
+
For a detailed list of changes and updates, please refer to the [document](CHANGELOG.md) file.
|