From abca0509da7f8906aaea95777ab16b5b8017a9ac Mon Sep 17 00:00:00 2001 From: zevaryx Date: Fri, 7 Mar 2025 08:40:49 -0700 Subject: [PATCH] [docs] Fix README, guide --- README.md | 19 +++++++++++++++++++ docs/guide.rst | 3 --- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20c9bc0..e6b7155 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Scryfall-py An async Scryfall API wrapper written in Python + +## Usage + +### Installation + +To get started, install `scryfall-py` + +`pip install scryfall-py` + +### Getting started + +```py +from scryfall import Scryfall +client = Scryfall() + +card = await client.search_cards_named("Arcades, the Strategist") +``` + +This will fetch the card Arcades, the Strategist from the Scryfall API diff --git a/docs/guide.rst b/docs/guide.rst index fbd2d8a..a432bcb 100644 --- a/docs/guide.rst +++ b/docs/guide.rst @@ -12,9 +12,6 @@ To get started, install ``scryfall-py``:: Getting Started *************** -Hashing Files -~~~~~~~~~~~~~ - .. code-block:: python from scryfall import Scryfall