-
Notifications
You must be signed in to change notification settings - Fork 524
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add Ocelloids Monitoring SDK milestone 1 delivery
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Milestone Delivery :mailbox: | ||
|
||
**The [invoice form :memo:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** | ||
|
||
* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/ocelloids_monitoring_sdk.md | ||
* **Milestone Number:** 1 | ||
|
||
**Context** | ||
|
||
This milestone delivery encompasses key components of the Ocelloids Monitoring SDK. The deliverables include the Core SDK (Deliverable 1), which serves as the foundation for monitoring functionality, ink! Contracts Domain Logic (Deliverable 2) for seamless integration with ink! contracts, and an example application (Deliverable 3) that demonstrates the practical usage and capabilities of the SDK. | ||
|
||
**Deliverables** | ||
|
||
| Number | Deliverable | Link | Notes | | ||
| ------- | ------------- | ------------- |------------- | | ||
| **0a.** | License | https://github.com/sodazone/ocelloids/blob/main/LICENSE | | | ||
| **0b.** | Documentation | <ul><li>https://github.com/sodazone/ocelloids/blob/main/README.md</li><li>https://github.com/sodazone/ocelloids/blob/main/guides/QUICKSTART.md</li><li>https://sodazone.github.io/ocelloids/</li></ul>| There are detailed READMEs for each module and also inline source code documentation. We also have a quickstart guide and a documentation site to help with setting up the first Ocelloids project. | | ||
| **0c.** | Testing and Testing Guide | https://github.com/sodazone/ocelloids#testing | | | ||
| 1. | Core SDK | https://github.com/sodazone/ocelloids/tree/main/packages/core | | | ||
| 2. | ink! Contracts Domain Logic | https://github.com/sodazone/ocelloids/tree/main/packages/pallets/contracts | | | ||
| 3. | Example application | https://github.com/sodazone/ocelloids/tree/main/examples/watch-contracts | | | ||
|
||
**Additional Information** | ||
|
||
The core and contracts pallet packages are published in the public NPM registry. |