doc

README.md

 # Twint Api
 
-API for twint
\ No newline at end of file
+A simple API wrapper HTTP server for twint.
+
+## Install
+
+The Docker image is at `git-registry.mycard.moe/nanahira/twint-api`, or you may use the Dockerfile inside.
+
+The only port this container listens on is `80`.
+
+## API
+
+- `POST /Search`
+
+- `POST /Profile`
+
+- `POST /Favorites`
+
+For [param data](https://github.com/twintproject/twint/wiki/Configuration) and [return data](https://github.com/twintproject/twint/wiki/Tweet-attributes), see the API documentation of Twint.