mirror of
https://github.com/jlengrand/OpenGraphKt.git
synced 2026-03-10 08:31:23 +00:00
58 lines
2.0 KiB
Markdown
58 lines
2.0 KiB
Markdown
# OpenGraphKt
|
|
|
|
[](https://github.com/simplex-chat/jlengrand/OpenGraphKt/workflows/gradle.yml)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[OpenGraphKt](https://github.com/jlengrand/OpenGraphKt) is a minimalist Kotlin library to work with the [Open Graph tags](https://ogp.me/) protocol.
|
|
OpenGraphKt is a tiny wrapper on top of JSoup.
|
|
|
|
## Current status
|
|
|
|
* Library can extract OpenGraph tags from HTML via a `URL`, `String` or `File` input.
|
|
* Current implementation is JVM only, due to the `JSoup` dependency.
|
|
* Protocol implementation is complete for `og:` tags, but types aren't fully correct (most types currently are `String`).
|
|
* Library should be considered in pre-alpha, use this in production at your own risks :).
|
|
|
|
## Usage
|
|
|
|
See [Main.kt](./demo-remote/src/main/kotlin/fr/lengrand/opengraphktremote/Main.kt) in the `demo-remote` submodule for usage examples.
|
|
|
|
In short :
|
|
|
|
* Add dependency to your Maven / Gradle file. For example :
|
|
|
|
```bash
|
|
implementation("fr.lengrand:opengraphkt:0.0.2")
|
|
```
|
|
|
|
* Enjoy:
|
|
|
|
```kotlin
|
|
val parser = Parser()
|
|
val openGraphDataDoc = parser.parse("https://www.imdb.com/title/tt0068646/")
|
|
|
|
println("Title: ${openGraphDataDoc.title}")
|
|
println("Is valid: ${openGraphDataDoc.isValid()}")
|
|
|
|
// Title: The Rock
|
|
// Is valid: true
|
|
```
|
|
|
|
|
|
## Dependencies
|
|
|
|
- [JSoup](https://jsoup.org/)
|
|
|
|
## Author
|
|
|
|
* [Julien Lengrand-Lambert](https://github.com/jlengrand)
|
|
|
|
## License
|
|
|
|
* [The MIT LICENCE. See License](./LICENSE) |