Readme update (#197)

* Readme update

* Update README.md

* Remove develop publish

.github/workflows/docs.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - develop # TODO remove once we have the first version of the docs up.
 permissions:
   contents: write
 jobs:

README.md

@@ -10,6 +10,10 @@
 [![](https://img.shields.io/badge/python-3.8+-blue.svg)](https://pypi.org/project/automata-lib/)
 [![status](https://joss.theoj.org/papers/fe4d8521383598038e38bc0c948718af/status.svg)](https://joss.theoj.org/papers/fe4d8521383598038e38bc0c948718af)
 
+- **Documentation**: https://caleb531.github.io/automata/
+- **Migration Guide**: https://caleb531.github.io/automata/migration/
+- **API**: https://caleb531.github.io/automata/api/
+
 Automata is a Python 3 library implementing structures and algorithms for manipulating finite automata,
 pushdown automata, and Turing machines. The algorithms have been optimized and are capable of
 processing large inputs. Visualization logic has also been implemented. This package is suitable for
@@ -38,14 +42,6 @@ this project! 🎉
 [khoda81]: https://github.com/khoda81
 [christopher-hampson]: https://github.com/christopher-hampson
 
-## Migrating to v8
-
-If you wish to migrate to Automata v8 from an older version, please follow the
-[migration guide][migration].
-
-<!-- the below link must be an absolute URL to be functional in the PyPI README -->
-[migration]: https://github.com/caleb531/automata/blob/main/MIGRATION.md
-
 ## Installing
 
 You can install the latest version of Automata via pip:
@@ -60,14 +56,6 @@ To install the optional visual dependencies, use the `visual` extra:
 pip install 'automata-lib[visual]'
 ```
 
-## API
-
-Please refer to [the official API Documentation][docs] in the `docs/` directory
-of the GitHub repository.
-
-<!-- the below link must be an absolute URL to be functional in the PyPI README -->
-[docs]: https://github.com/caleb531/automata/blob/main/docs/README.md
-
 ## Contributing
 
 Contributions are always welcome! Take a look at the [contributing guide](./CONTRIBUTING.md).