Skip to content

Commit

Permalink
Prepare for release v1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
saket committed Mar 18, 2022
1 parent a4d153a commit 362e82d
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 1,30 @@
# unfurl

`unfurl` extracts social metadata of webpages for generating their previews, inspired by slack.

```kotlin
val unfurler = Unfurler()
println(unfurler.unfurl("https://saket.me/great-teams-merge-fast/"))
```

```text
UnfurlResult(
url = https://saket.me/great-teams-merge-fast/,
title = Great teams merge fast,
description = Observations from watching my team at Square produce stellar work while moving fast and not breaking things.,
favicon = https://saket.me/wp-content/uploads/2022/03/cropped-saket-photo-180x180.jpg,
thumbnail = https://saket.me/wp-content/uploads/2021/02/great_teams_merge_fast_cover.jpg
url = "https://saket.me/great-teams-merge-fast",
title = "Great teams merge fast",
description = "Observations from watching my team at Square produce stellar work while moving fast and not breaking things.",
favicon = "https://saket.me/wp-content/uploads/2022/03/cropped-saket-photo-180x180.jpg",
thumbnail = "https://saket.me/wp-content/uploads/2021/02/great_teams_merge_fast_cover.jpg"
)
```

```groovy
implementation "me.saket.unfurl:unfurl:1.5.0"
```

### cli
```bash
$ brew install saket/repo/unfurl
$ unfurl https://saket.me/great-teams-merge-fast
```

## License

```
Expand Down
2 changes: 1 addition & 1 deletion cli/src/main/kotlin/me/saket/unfurl/cmd/UnfurlCommand.kt
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 29,11 @@ class UnfurlCommand : CliktCommand(name = "unfurl") {
}
)

echo("")
val unfurled = unfurler.unfurl(url)
if (unfurled == null) {
echo("Couldn't unfurl", err = true)
} else {
echo("")
with(unfurled) {
when (title) {
null -> echo("Title: null")
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
GROUP=me.saket.unfurl
VERSION_NAME=1.1.0
VERSION_NAME=1.5.0

POM_URL=https://github.com/saket/unfurl
POM_SCM_URL=https://github.com/saket/unfurl
Expand Down
2 changes: 1 addition & 1 deletion unfurl/gradle.properties
Original file line number Diff line number Diff line change
@@ -1,4 1,4 @@
POM_ARTIFACT_ID=unfurl
POM_NAME=unfurl
POM_DESCRIPTION=Generate preview of link, inspired by Slack.
POM_DESCRIPTION=Generate preview of links, inspired by Slack.
POM_PACKAGING=jar

0 comments on commit 362e82d

Please sign in to comment.