From f430b1f11b4a3be9852c625b0031cefac436c230 Mon Sep 17 00:00:00 2001 From: Vahid Al Date: Thu, 28 Dec 2023 21:55:18 +0330 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f764d30..7a32fcf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# github-actions-python -Playing around with GitHub Actions and Pages. +# Jake + +Jake is a tool that allows you to effortlessly create your own one-link website and deploy it on your GitHub account. + +## Usage + +### Create a Repository +To get started, follow these steps to create a new repository using this template: + +1. Click [here](https://github.com/new?template_name=jake&template_owner=thevahidal) to create a new repository. +2. Choose a name for your repository. If you want your website to be deployed at `.github.io`, name your repository `.github.io`. Alternatively, you can choose any other name, such as `that-other-name`, which will result in your website being deployed at `.github.io/that-other-name/`. + +### Enable GitHub Pages +After creating the repository, you need to enable GitHub Pages. Follow these steps: + +1. Go to your repository's `Settings` tab. +2. Navigate to the `Pages` section. +3. Choose `GitHub Actions` as the source for your GitHub Pages. +4. Click `Save` to apply the changes. + +### Voila! +That's all you need to do. Now, you can sit back and relax while your website gets deployed. You can monitor the progress in the `Actions` tab of your repository. Once the deployment is complete, you can access your brand new one-link website at `.github.io` or `.github.io/repo-name/`. + +Feel free to customize your website by modifying the code and adding your own content. + +## Contributing +If you find any issues or have suggestions for improvement, please feel free to contribute by submitting a pull request or creating an issue in the repository. + +## License +This project is licensed under the [MIT License](LICENSE).