Skip to content

Commit 7ef4673

Browse files
authored
Create README.md
1 parent faaaf0d commit 7ef4673

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# kotlin-unsigned
22

3-
Unsigned operators and boxed types (Ubyte, Uint, Ulong and Ushort) for unsigned support.
3+
Unsigned operators and boxed types (`Ubyte`, `Uint`, `Ulong` and `Ushort`) for unsigned support.
44

5-
Gradle:
5+
[Gradle](https://jitpack.io/#kotlin-graphics/kotlin-unsigned/v2.1)
66

77
- Add it in your root build.gradle at the end of repositories:
88

@@ -19,10 +19,18 @@ Gradle:
1919
compile 'com.github.kotlin-graphics:kotlin-unsigned:v2.1'
2020
}
2121

22+
[Maven, Sbt, Leiningen](https://jitpack.io/#kotlin-graphics/kotlin-unsigned/v2.1)
2223

2324

24-
[Maven, Sbt, Leiningen](https://jitpack.io/#kotlin-graphics/kotlin-unsigned/v2.1)
25+
To have a quick idea what this library offers, take a look at the [tests](https://github.com/kotlin-graphics/kotlin-unsigned/blob/master/src/test/kotlin/unsigned/unsigned.kt)
26+
27+
Hightlights:
28+
29+
Android compatible, sources compiled with java 1.7.
30+
31+
All unsigned methods available for `int`s and `long`s on java 1.8 have been reported here.
2532

33+
These are offered directly on the corresponding [`Int`](https://github.com/kotlin-graphics/kotlin-unsigned/blob/android/src/main/kotlin/unsigned/java_1_7/int.kt) and [`Long`](https://github.com/kotlin-graphics/kotlin-unsigned/blob/android/src/main/kotlin/unsigned/java_1_7/long.kt) Kotlin primitives (with `infix` too)
2634

2735
Don't hesitate to contribute to the project by submitting [issues](https://github.com/kotlin-graphics/kotlin-unsigned/issues) or [pull requests](https://github.com/kotlin-graphics/kotlin-unsigned/pulls) for bugs and features. Any feedback is welcome at [[email protected]](mailto://[email protected]).
2836

0 commit comments

Comments
 (0)