Skip to content

Commit de5a6d7

Browse files
committed
docs(readme): update readme
1 parent 1d15997 commit de5a6d7

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ It's feature rich and written in pure NetLinx.
4141
- Comprehensive utility libraries for common tasks
4242
- Well-tested and production-ready components
4343
- Consistent API design across all modules
44-
- Full compatibility with AMX NetLinx Studio
4544
- Extensive error handling and logging capabilities
4645

4746
## Installation :zap:
@@ -50,7 +49,7 @@ This library can be installed using [Scoop](https://scoop.sh/).
5049

5150
```powershell
5251
# If you don't have sudo installed - Required to create symlinks in the AMX directory
53-
scoop install sudo
52+
scoop install gsudo
5453
5554
# Add the Norgate-AV AMX bucket
5655
scoop bucket add norgateav-amx https://github.com/Norgate-AV/scoop-norgateav-amx
@@ -59,6 +58,24 @@ scoop bucket add norgateav-amx https://github.com/Norgate-AV/scoop-norgateav-amx
5958
sudo scoop install navfoundation-amx
6059
```
6160

61+
## Usage :rocket:
62+
63+
To use the NAVFoundation.Amx libraries in your NetLinx project, simply include the desired library files in your project.
64+
65+
### Example
66+
67+
To use the `StringUtils` library, you would include it as follows:
68+
69+
```c
70+
#include "NAVFoundation.StringUtils.axi"
71+
```
72+
73+
To use the `ArrayUtils` library, you would include it as follows:
74+
75+
```c
76+
#include "NAVFoundation.ArrayUtils.axi"
77+
```
78+
6279
## Documentation :page_facing_up:
6380

6481
For more detailed guides and documentation, please refer the `README.md` files in each library folder.
@@ -70,6 +87,7 @@ For more detailed guides and documentation, please refer the `README.md` files i
7087
- [ArrayUtils](./ArrayUtils)
7188
- Provides utility functions for working with arrays in AMX.
7289
- [Assert](./Assert)
90+
- Provides assertion functions for testing and debugging.
7391
- [BinaryUtils](./BinaryUtils)
7492
- Provides functions for binary data manipulation and conversion.
7593
- [Cryptography](./Cryptography)
@@ -101,6 +119,7 @@ For more detailed guides and documentation, please refer the `README.md` files i
101119
- [Json](./Json)
102120
- Provides functions for working with JSON data.
103121
- [List](./List)
122+
- Provides an array-based list implementation.
104123
- [LogicEngine](./LogicEngine)
105124
- [Math](./Math)
106125
- Provides mathematical functions and utilities.
@@ -109,9 +128,11 @@ For more detailed guides and documentation, please refer the `README.md` files i
109128
- [NetUtils](./NetUtils)
110129
- Provides network-related utility functions.
111130
- [NtpUtils](./NtpUtils)
131+
- Provides functions for working with NTP (Network Time Protocol).
112132
- [PathUtils](./PathUtils)
113133
- Provides utility functions for file path manipulation.
114134
- [Queue](./Queue)
135+
- Provides an array-based queue implementation.
115136
- [Regex](./Regex)
116137
- Provides regular expression matching and manipulation functions.
117138
- [Redis](./Redis)

0 commit comments

Comments
 (0)