Skip to content

Commit 3b02c0f

Browse files
Merge pull request #6 from target/aaronriekenberg-patch-3
Update README.md
2 parents c6a3da3 + ed54088 commit 3b02c0f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This project provides the following components:
1717
* Advantages of this design:
1818
* All allocate, resize, and free operations after startup are very fast because they do not do native-memory
1919
allocation or free operations
20-
* Fragmentation is not an issue because OffHeapMemoryBuffer has no requirement for memory pages to be contiguous
20+
* Fragmentation is not an issue because NativeMemoryBuffer has no requirement for memory pages to be contiguous
2121
* Buffer
2222
* Supports OnHeapMemoryBuffer as a normal on-heap byte array
2323
* Supports NativeMemoryBuffer as a list of native memory pages allocated by NativeMemoryAllocator
@@ -37,6 +37,12 @@ See the `examples` directory for complete runnable example applications.
3737

3838
Basic steps to use NativeMemoryAllocator:
3939

40+
Add the following repository to maven or gradle build:
41+
```
42+
https://maven.pkg.github.com/target/native_memory_allocator
43+
```
44+
Add `com.target:native_memory_allocator` dependency to maven or gradle build - see [releases page](https://github.com/target/native_memory_allocator/packages/1407699) for current version.
45+
4046
Define a map value object.
4147

4248
```
@@ -125,4 +131,4 @@ To generate HTML documentation use the following command:
125131
./gradlew -PdokkaEnabled=true dokkaHtml
126132
```
127133

128-
Open `build/dokka/html/index.html` to view generated documentation.
134+
Open `build/dokka/html/index.html` to view generated documentation.

0 commit comments

Comments
 (0)