Skip to content

Commit 818a130

Browse files
committedMar 10, 2025··
Update README.md
1 parent fa013d8 commit 818a130

File tree

1 file changed

+4
-40
lines changed

1 file changed

+4
-40
lines changed
 

‎README.md

+4-40
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
11
# UUID Plus
22

33
> **⚠️ FORK NOTICE: This repository is a fork of the [original dart-uuid](https://github.com/Daegalus/dart-uuid) by [Daegalus](https://github.com/Daegalus). maintained by Input Output Global, Inc. (IOG)**
4-
5-
6-
[![Build Status](https://github.com/Daegalus/dart-uuid/workflows/Dart/badge.svg?branch=main&event=push)](https://github.com/Daegalus/dart-uuid/actions)
4+
>
5+
> Original [README](https://github.com/Daegalus/dart-uuid/blob/main/README.md), [License](https://github.com/Daegalus/dart-uuid/blob/main/LICENSE) and [Documentation](https://daegalus.github.io/dart-uuid/index.html).
76
87
Simple, fast generation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) and [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) UUIDs.
98

109
- [UUID Plus](#uuid-plus)
1110
- [Getting Started](#getting-started)
1211
- [Instructions](#instructions)
1312
- [Pubspec](#pubspec)
14-
- [Documentation](#documentation)
1513
- [Testing](#testing)
1614
- [Running Tests in Native Environment](#running-tests-in-native-environment)
1715
- [Running Tests in Browser Environment](#running-tests-in-browser-environment)
18-
- [Performance Considerations](#performance-considerations)
1916
- [Release notes](#release-notes)
2017
- [Attribution](#attribution)
2118

2219
Features:
2320

2421
* Generate RFC4122 version 1, version 4, or version 5 UUIDs
2522
* Supports RFC9562 version 6, version 7, and version 8
26-
* Supported Platforms:
27-
* Web
28-
* Server
29-
* iOS
30-
* Android
31-
* Linux
32-
* MacOS
33-
* Windows (not tested)
23+
* Supported Platforms: Web, Server, iOS, Android, Linux, MacOS, Windows
3424
* Cryptographically strong random number generation on all platforms
3525

3626
## Getting Started
@@ -63,12 +53,6 @@ uuid.v4(); // -> '110ec58a-a0f2-4ac4-8393-c866d813b8d1'
6353
uuid.v5(Uuid.NAMESPACE_URL, 'www.google.com'); // -> 'c74a196f-f19d-5ea9-bffd-a2742432fc9c'
6454
```
6555

66-
## Documentation
67-
68-
For documentation, please visit the [Documentation](https://daegalus.github.io/dart-uuid/index.html) page. Examples are included for most functions and classes.
69-
70-
For more complex examples and other usages, please look at the [tests](test/uuid_test.dart).
71-
7256
## Testing
7357

7458
The library comes with a comprehensive test suite. Here's how to run the tests:
@@ -102,24 +86,7 @@ dart test test/uuid_test.dart test/other_test.dart
10286

10387
### Running Tests in Browser Environment
10488

105-
First, ensure you have the necessary dependencies in your `pubspec.yaml`:
106-
107-
```yaml
108-
dev_dependencies:
109-
build_runner: ^2.4.8
110-
build_web_compilers: ^4.0.9
111-
```
112-
113-
Create a `dart_test.yaml` file in your project root:
114-
115-
```yaml
116-
# You can also specify [chrome, firefox] for multiple browsers
117-
platforms: [chrome]
118-
concurrency: 1
119-
timeout: 2x
120-
```
121-
122-
Then run:
89+
To run all tests:
12390

12491
```bash
12592
# Run all tests in Chrome
@@ -150,9 +117,6 @@ dart test test/uuid_test.dart --name="UUID v7 has mathematically sufficient rand
150117

151118
This will open Chrome and pause execution, allowing you to use Chrome DevTools for debugging.
152119

153-
### Performance Considerations
154-
155-
Some tests (particularly collision tests) may run millions of iterations. For browser testing, consider using the entropy-based validation tests instead of the brute-force collision tests, as they provide similar validation in a fraction of the time.
156120

157121
## Release notes
158122

0 commit comments

Comments
 (0)
Please sign in to comment.