From a873157220beffc8c31bc0cf78c0e811108abc29 Mon Sep 17 00:00:00 2001 From: Shahn Hogan Date: Tue, 14 May 2024 12:41:43 -0500 Subject: [PATCH] Update README.md (#1) Fix typos and improve grammar --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 96e372c..701eb96 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # elm-to-pages 🌳 -`elm-to-gh-pages` is an example of how to deploy an Elm app to GitHub pages using GitHub Actions. You can either copy this repo and start from their, or follow the explanation below to setup an existing project ⬇️. +`elm-to-gh-pages` is an example of how to deploy an Elm app to GitHub pages using GitHub Actions. You can either copy this repo and start from there, or follow the explanation below to setup an existing project ⬇️. ## Usage In a _public_ GitHub repo, go to `Settings > Pages > Source` and choose `GitHub Actions` instead of `Deploy from a branch`. Now create a directory `.github/workflows/` and put [`elm-to-gh-pages.yml`](./.github/workflows/elm-to-gh-pages.yml) in it. -On your next push, after a few moments, your Elm app will be deployed to `yourusername.github.io/yourreponame`! +On your next push, after a few moments, your Elm app will be deployed to `your-username.github.io/your-repo-name`! ## Configuration -If you would like compile your app to JS instead of HTML, update the command in the `Build Elm artifact` section to `elm make src/Main.elm --output=main.js`. Make sure that you have an `index.html` file in your repo. +If you would like to compile your app to JavaScript instead of HTML, update the command in the `Build Elm artifact` section to `elm make src/Main.elm --output=main.js`. Make sure that you have an `index.html` file in your repo. If your app does not use `Debug` and you would like the compiled code to be optimized, use `elm make src/Main.elm --output=main.js --optimize`. @@ -24,4 +24,4 @@ To take it one step further, you can add the following block below the `Build El ``` ## Contributing -Pull requests are welcome, especially if you have an idea on making this easier to use! \ No newline at end of file +Pull requests are welcome, especially if you have an idea on making this easier to use!