update readme

Author: stringertheory

README.md

@@ -6,45 +6,24 @@
 [![Commit activity](https://img.shields.io/github/commit-activity/m/stringertheory/clean-links)](https://img.shields.io/github/commit-activity/m/stringertheory/clean-links)
 [![License](https://img.shields.io/github/license/stringertheory/clean-links)](https://img.shields.io/github/license/stringertheory/clean-links)
 
-Tools for cleaning up linkss
+Tools for cleaning up links.
 
-- **Github repository**: <https://github.com/stringertheory/clean-links/>
-- **Documentation** <https://stringertheory.github.io/clean-links/>
+Remove cruft from URLs using the rules from
+https://github.com/ClearURLs/Rules
 
-## Getting started with your project
+Unshorten URLs by making requests and following redirects.
 
-First, create a repository on GitHub with the same name as this project, and then run the following commands:
+Are these two links the same?
 
-```bash
-git init -b main
-git add .
-git commit -m "init commit"
-git remote add origin [email protected]:stringertheory/clean-links.git
-git push -u origin main
-```
-
-Finally, install the environment and the pre-commit hooks with
-
-```bash
-make install
-```
-
-You are now ready to start development on your project!
-The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
+```python
+link1 = "https://trib.al/5m7fAg3"
+link2 = "https://bit.ly/dirtylank"
 
-To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
-For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
-To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
+resolved1 = unshorten_url(link1).get("resolved")
+cleaned1 = clear_url(resolved1)
 
-## Releasing a new version
+resolved2 = unshorten_url(link2).get("resolved")
+cleaned2 = clear_url(resolved2)
 
-- Create an API Token on [Pypi](https://pypi.org/).
-- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/stringertheory/clean-links/settings/secrets/actions/new).
-- Create a [new release](https://github.com/stringertheory/clean-links/releases/new) on Github.
-- Create a new tag in the form `*.*.*`.
-
-For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
-
----
-
-Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
+cleaned1 == cleaned2  # True!
+```