From dfbd13b2baca7393cf68ba2dac705895c81c310a Mon Sep 17 00:00:00 2001
From: Evan Sosenko <evan@getseam.com>
Date: Thu, 27 Jun 2024 13:48:50 -0700
Subject: [PATCH] Update README

---
 README.md  | 50 --------------------------------------------------
 README.rst |  2 ++
 2 files changed, 2 insertions(+), 50 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index def2aa7..0000000
--- a/README.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# Seam for Python
-
-Control locks, lights and other internet of things devices with Seam's simple API. Check out the [documentation](https://docs.getseam.com) or [some examples](examples).
-
-## Setup
-
-```bash
-pip install seamapi
-```
-
-## Usage
-
-```python
-from seamapi import Seam
-
-# export SEAM_API_KEY=***
-seam = Seam()
-
-some_lock = seam.locks.list()[0]
-
-# TODO this syntax soon
-#some_lock = seam.locks.get(
-#  name="Front Door",
-#  location="123 Amy Lane"
-#)
-
-seam.locks.lock_door(some_lock)
-```
-
-## Development
-
-This project uses [poetry](https://github.com/python-poetry/poetry)
-
-- To setup the project and install dependencies run `poetry install`
-- To run tests, run `poetry run pytest -s`
-- To build the project for publishing, run `poetry build`
-
-Commits to `main` following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) will automatically be published to PyPI.
-
-Our tests use a seam sandbox environment given by the environment
-variables `SEAM_SANDBOX_API_KEY`. If you want to run the tests, you should
-first create a sandbox workspace [on your Developer Console](https://console.getseam.com)
-then create a sandbox workspace.
-
-> NOTE: For installation on m1 mac, you may need to export the following lines
-> prior to running `poetry install`
->
-> `export CPPFLAGS="-I/opt/homebrew/opt/openssl@1.1/include"`
->
-> `export LDFLAGS="-L/opt/homebrew/opt/openssl@1.1/lib -L${HOME}/.pyenv/versions/3.8.10/lib"`
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..bd2466f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,2 @@
+This package has moved to `seam <https://pypi.org/project/seam/>`_.
+Please refer to the `migration guide <https://github.com/seamapi/python/releases/tag/v1.0.0rc0>`_.