diff --git a/README.md b/README.md index 2d18934..7d16482 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ # mitnal + +Twitter client for UEFI. + +## Screenshot + +![](Static/ScreenShot.png) + +## Requirements + +You need to enable "HTTP Protocol Stack Support" in your UEFI. + +## How to build + +Create a `MitnalPkg/Secrets` file as follows: + +```c +static const CHAR8 *gConsumerKey = ""; +static const CHAR8 *gConsumerSecret = ""; +static const CHAR8 *gAccessToken = ""; +static const CHAR8 *gAccessTokenSecret = ""; +``` + +Then, + +```bash +$ make docker/build +$ make run +``` + +## Usage + +Here is a list of available command: + +- `home`: show your timeline +- `tweet hello`: tweet 'hello' diff --git a/Static/ScreenShot.png b/Static/ScreenShot.png new file mode 100644 index 0000000..021fce3 Binary files /dev/null and b/Static/ScreenShot.png differ