status-im
/
kudos-medals
mirror of https://github.com/status-im/kudos-medals.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added type schema section

This commit is contained in:
Samuel Hawksby-Robinson 2024-03-20 10:31:31 +00:00
parent c52f33dc40
commit db4bea4fc2
No known key found for this signature in database
GPG Key ID: CBB7A42643E04A78
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -2,12 +2,18 @@
Portable and immutable rewards and acknowledgements.
- [Sample Collection](#sample-collection)
- [Samples with details](#samples-with-details)
- [Type Schema](#type-schema)
- [References](#ref)
## Sample Collection
| | | | | | |
|---------------------------------------------------------------------|-----------------------------------------------------------------------|------------------------------------------------------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------|
| <img alt="Sample medal" src="/src/composites/manual/composite.svg"> | <img alt="Sample medal" src="/src/composites/manual/composite_2.svg"> | <img alt="Sample medal" src="/src/composites/manual/composite_3_.svg"> | <img alt="Sample medal" src="/src/composites/manual/composite_4.svg"> | <img alt="Sample medal" src="/src/composites/manual/composite_5.svg"> | <img alt="Sample medal" src="/src/composites/manual/composite_6.svg"> |
## Samples with details
| Type | Image | Data |
|------------------------------------------------------------------------|---------------------------------------------|------------------------------------------------------------------|
| <img alt="Sample medal" src="/src/composites/manual/composite.svg"> | **medal:status:crew:ui_polishers** | [metadata json](metadata/medal.status.crew.ui_polishers.json) |
@ -17,6 +23,23 @@ Portable and immutable rewards and acknowledgements.
| <img alt="Sample medal" src="/src/composites/manual/composite_5.svg"> | **medal:status:anniversary:1** | [metadata json](metadata/medal.status.anniversary.1.json) |
| <img alt="Sample medal" src="/src/composites/manual/composite_6.svg"> | **medal:status:crew_captain:ui_polishers** | [metadata json](metadata/medal.status.captain.ui_polishers.json) |
## Type Schema
The following is an example of a reward type:
`medal:status:anniversary:6`
This type identifier follows the below schema
`<AWARD_TYPE>:<PROJECT_NAME>:<AWARD_SUBTYPE>:<AWARD_SUBTYPE_DATA>`
| Type | Description | Type examples |
|----------------------|-----------------------------------------------------------------------------|--------------------------------------|
| `AWARD_TYPE` | The type of award given, this give context to the underlying award | `medal`, `certificate`, `trophy` |
| `PROJECT_NAME` | The project that has issued the award | `status`, `waku`, `logos` |
| `AWARD_SUBTYPE` | Describes what the award is for. Example a `medal` for a work `anniversary` | `anniversary`, `crew`, `captainhood` |
| `AWARD_SUBTYPE_DATA` | Data about the subtype | `perf`, `6` |
## Ref
https://github.com/ethereum/ercs/blob/master/ERCS/erc-1155.md