Skip to content

Commit 610f8a1

Browse files
authored
docs: update README (#992)
* docs: update README to reflect final development stage and upcoming release preparations * docs: update README resources list * docs: correct spelling in vLEI ISO Standardization link
1 parent 5e481bb commit 610f8a1

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,8 @@
1212
# Disclaimer
1313

1414
<div align="justify">
15-
<b> Please be aware that your access to and use of the Open-Source Identity Wallet, including any content you may encounter, is subject to your own discretion and risk. Currently, the identity wallet is under-development with security audits and threat modelling still pending. It is essential to understand, this version of the identity wallet does not currently feature encryption-at-rest, nor does it offer robust recovery or backup solutions. Furthermore, any seed phrase generated during the onboarding process is currently not being utilised. We are in the process of reviewing the ideal key management and social recovery methodologies for development in 2024. </b>
15+
<b> Currently, the Identity Wallet is in its final stage of development for an initial release. We are conducting third-party security audits, threat modeling, and penetration testing in preparation for deployment to the iOS and Android App Stores. Some of the information and visuals below are being updated as we move towards the release. </b>
1616
</div>
17-
<br>
18-
<div align="center">
19-
<b> :heavy_exclamation_mark: The Open-Source Identity Wallet is provided to you on an "as is" and "as available" basis. </b>
20-
</div>
21-
<br>
22-
<div align="justify">
23-
<b> While we strive for high functionality and user satisfaction and endeavour to maintain reliability and accuracy, unforeseen issues may arise due to the experimental nature of this product. For detailed information on the terms and conditions that govern your use of the Open-Source Identity Wallet, we encourage you to read our Terms of Use. </b>
24-
</div>
25-
2617
<br>
2718

2819
# Overview
@@ -47,10 +38,10 @@
4738
- :cloud: High messaging availability with a KERIA cloud agent
4839
- :closed_lock_with_key: Secure Enclave (SE) / Trusted Execution Environment (TEE) usage for seeds & secrets
4940
- :id: KERI autonomic identifiers
50-
- Direct-mode, witness-backed, Cardano-backed
41+
- Securely backed by a combination of KERI native witnesses and Cardano
5142
- Single-sig, multi-sig
5243
- :ticket: ACDC credentials exchanged using the IPEX protocol
53-
- :zap: Efficient over-the-wine communications using CESR encoding
44+
- :zap: Efficient over-the-wire communications using CESR encoding
5445
- :desktop_computer: dApp integration using [CIP-45](https://cips.cardano.org/cip/CIP-0045)
5546

5647
# Future Developments
@@ -161,7 +152,7 @@ Please read [Contributing](CONTRIBUTING.md) in advance. Thank you for contribut
161152

162153
# Troubleshooting
163154
<div align="justify">
164-
Please be aware that from time-to-time the hosted pre-production KERI services require restarting. When this occurs it causes a white-screen when launching the application. If you experience the white-screen issue please wait for the services to restart and the application will load as expected. If you have any questions, there is also a Discord Channel available for the Identity Wallet.
155+
If you encounter any issues or have questions, please drop us a message on our Discord channel. We are here to help!
165156
</div>
166157

167158
<br>
@@ -182,7 +173,6 @@ Please be aware that from time-to-time the hosted pre-production KERI services r
182173

183174
## Standards, Frameworks and Governance
184175
- [SSI Frameworks Overview](https://europeanblockchainassociation.org/ssi-frameworks-sdks-overview/)
176+
- [Trust over IP](https://trustoverip.org/)
185177
- [Global Legal Entity Identifier Foundation (GLIEF)](https://www.gleif.org/en)
186-
- [Decentralized Identity Foundation](https://identity.foundation/)
187-
- [eIDAS Regulation](https://digital-strategy.ec.europa.eu/en/policies/eidas-regulation)
188-
- [European Blockchain Services Infrastructure (EBSI)](https://ec.europa.eu/digital-building-blocks/wikis/display/EBSI/Home)
178+
- [vLEI ISO Standardization](https://www.gleif.org/media/pages/newsroom/press-releases/iso-standardizes-gleif-s-pioneering-digital-organizational-identity-offering-with-publication-of-vlei-technical-standard/42372c4929-1740658674/2024-10-14_iso-standardizes-gleif-s-pioneering-digital-organizational-identity-offering-with-publication-of-vlei-technical-stand.pdf)

0 commit comments

Comments
 (0)