From 61ebc9e93cc60df679a3d623967d174140d48232 Mon Sep 17 00:00:00 2001
From: Paul Armstrong <paul@spaceyak.com>
Date: Mon, 28 Aug 2023 08:19:24 -0700
Subject: [PATCH] docs: add readme info, funding

---
 .github/FUNDING.yml |  2 ++
 README.md           | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 .github/FUNDING.yml

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..c70a850
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github:
+  - paularmstrong
diff --git a/README.md b/README.md
index fe1b1c6..4517a65 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
 # remove-aliasing
+
+Remove import path aliasing from your application.
+
+## Usage
+
+```sh
+npx remove-aliasing [options] <directory>
+```
+
+## Example
+
+```sh
+npx remove-aliasing@latest --root="src/" --prefix="@/" src/
+```
+
+## Options
+
+| Option      | Alias | Description                                        | Required |
+| ----------- | ----- | -------------------------------------------------- | -------- |
+| `--dry-run` |       | Do not actually write, just see what will happen   |          |
+| `--root`    | `-r`  | Directory that serves as the root of aliased files | ✅       |
+| `--prefix`  | `-p`  | Import path prefix, if any                         |          |
+| `--parser`  |       | Parser to use when reading files. Default `tsx`    |          |
+
+## License
+
+MIT License
+
+Copyright (c) 2023 Paul Armstrong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.