sticks/teamhydra_id_generator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add examples and update readme

Browse Source
This commit is contained in:
Tanner Sommers 2024-10-19 14:35:11 -05:00
parent 3745b39726
commit 5aeb6eda9c
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -19,9 +19,18 @@ You will need a valid username and token to use this package. If you do not have
## Usage ## Usage
TODO: Include short and useful examples for package users. Add longer examples You can see an example in the /example folder, but a simple example is shown below:
to `/example` folder.
```dart ```dart
const like = 'sample'; // Import the package
import 'package:teamhydra_idgen/teamhydra_idgen.dart';
void main() async {
IDGen idgen = IDGen(username: 'your_username', token: 'your_token');
// Generate a new ID, in this example we are generating a UUID V4
IDGenResponse uuid =
await idgen.generateUUIDV4(); // all generations are async
print('Generated UUID: ${uuid.id}'); // print the generated ID
}
``` ```

9
example/idgen_dart_example.dart
View File

@ -4,8 +4,9 @@ import 'package:teamhydra_idgen/teamhydra_idgen.dart';
void main() async { void main() async {
IDGen idgen = IDGen(username: 'your_username', token: 'your_token'); IDGen idgen = IDGen(username: 'your_username', token: 'your_token');
// Generate a new ID, in this example we are generating a UUID V4 // A more complex example can be generating a new IDs with a specific alphabet
IDGenResponse uuid = // and length
await idgen.generateUUIDV4(); // all generations are async IDGenResponse newID = await idgen.generateNanoID(
print('Generated UUID: ${uuid.id}'); // print the generated ID alphabet: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789', size: 20);
print('New ID: ${newID.id}');
} }