misikora / ruler Goto Github PK

Document basic usage, purpose and restricitions of the library.

While for SI units it does not provide any real benefit it makes sense for imperial system to represent lengths in a format like 6ft 7in. Custom distance formatter would allow users to do so.

👋 https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter

Blocked by: Kotlin/dokka#1730, Kotlin/kotlinx.html#173

Document public API for the consumers.

Add centimetre, decimetres and their symmetric counterparts (hectometres and dekametres). Ruler user-friendly length converting can now be handled thanks to Length.withFittingUnit().

Need to take care somehow of the Arabic translations.

Dokka should provide GFM output that can be used by MkDocs to deploy it to the website.