Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sollace authored Oct 15, 2024
1 parent 53f400d commit 741bb81
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
# Romanizer

Provides a number converter for translating between regular integers and their equivalent extended roman numerals.
Provides a number converter for translating between regular integers and their equivalent extended roman numerals representation.

# How To Use

TODO:
Converting to roman numerals:
```
String result = Romanizer.romanize(5); // --> "IV"
```

Converting from roman numerals:
```
int number = Romanizer.deromanize("IV"); // --> 5
```

# Adding to your project

TODO:
You can download the jar and sources from the [releases tab](https://github.com/Sollace/Romanizer/releases)

Add it to a folder in your gradle project named "lib" and then specify it as a dependency like so:

```
repositories {
flatDir { dirs 'lib' }
}
...
dependencies {
compileOnly "com.sollace:Romanizer:Romanizer:1.0.2"
}
```

0 comments on commit 741bb81

Please sign in to comment.