Skip to content

Commit 7734ccb

Browse files
committed
update README
2 parents 910d298 + c7a30a2 commit 7734ccb

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Scryfall.jl
2+
A Julia Scryfall.com Api wapper
3+
[check out api](https://Scryfall.com) api.
4+
5+
6+
| **Build Status** |
7+
|:-----------------------------------------------------------------------------------------------:|
8+
|[![Build Status](https://travis-ci.org/Moelf/Scryfall.jl.svg?branch=master)](https://travis-ci.org/Moelf/Scryfall.jl)|
9+
10+
## Installation
11+
12+
The package is registered in `METADATA.jl` and can be installed with `Pkg.add`, or in `REPL` by pressing `] add Scryfall`.
13+
```julia
14+
julia> Pkg.add("Scryfall")
15+
```
16+
17+
## Basic Usage
18+
```julia
19+
julia> import Scryfall
20+
21+
julia> Scryfall.getRaw("lightning bol")
22+
Dict{String,Any} with 56 entries:
23+
"foil" => true
24+
"mtgo_foil_id" => 67197
25+
"purchase_uris" => Dict{String,Any}("cardhoarder"=>"https://www.cardhoarder.com/cards/67…
26+
"oracle_text" => "Lightning Bolt deals 3 damage to any target."
27+
"scryfall_set_uri" => "https://scryfall.com/sets/a25?utm_source=api"
28+
"collector_number" => "141"
29+
"set" => "a25"
30+
"lang" => "en"
31+
...
32+
33+
julia> Scryfall.getImgurl("lightning bolt")
34+
"https://img.scryfall.com/cards/normal/front/e/3/e3285e6b-3e79-4d7c-bf96-d920f973b122.jpg?1562442158"
35+
36+
julia> Scryfall.getImgurl("lightning bolt", setCode="PRM")
37+
"https://img.scryfall.com/cards/normal/front/4/0/404a819c-8b9a-4527-a312-5e0df9c27be0.jpg?1562544239"
38+
```
39+
## To-Do
40+
- [ ] More fuzzy search, potentially from google or somewhere
41+
- [ ] Show all avaliable set code for a given card

0 commit comments

Comments
 (0)