5apps/manifique
5apps/manifique
4
0
Fork 0
Code Issues Pull Requests Releases 3 Activity

Add quick examples for icon selection to README

Browse Source
This commit is contained in:
Basti 2018-07-13 13:11:42 +02:00
parent c98efb9171
commit 857533eb6c
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,7 +8,7 @@ back to parsing HTML if necessary.
Add this line to your application's Gemfile: Add this line to your application's Gemfile:
```gem 'manifique'``` gem 'manifique'
And then execute: And then execute:
@ -30,9 +30,25 @@ agent = Manifique::Agent.new(url: "https://kosmos.social")
Now you can fetch its metadata: Now you can fetch its metadata:
```ruby ```ruby
puts agent.fetch_metadata metadata = agent.fetch_metadata
``` ```
### Selecting icons
Let's select an icon that we like:
```ruby
icon = metadata.select_icon(type: "image/png", sizes: "96x96")
```
Or maybe just iOS icons? They're pretty convenient for postprocessing after all.
```ruby
icon = metadata.select_icon(purpose: "apple-touch-icon", sizes: "180x180")
```
_TODO check out the docs for options and behavior._
## Development ## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run After checking out the repo, run `bin/setup` to install dependencies. Then, run