update readme

ooojpeg · Oct 21, 2021 · b1c34e8 · b1c34e8
1 parent 5cd026a
commit b1c34e8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 [![Bakers](https://opencollective.com/devlopr-jekyll/tiers/badge.svg)](https://opencollective.com/devlopr-jekyll/)
 
 
-You can use Devlopr as a starter for building your own Jekyll site. we purposely keep the styling minimal and bare to make it easier to add your own flare and markup. (Under Active Development) !
+You can use Devlopr as a starter for building your own Site. we purposely keep the styling minimal and bare to make it easier to add your own flare and markup. (Under Active Development) !
 
 Highly Customizable and No Hosting or Maintainence Cost is required !
 
@@ -48,7 +48,13 @@ Start the server locally at http://127.0.0.1:4000/ or http://localhost:4000/
 
 ### Github Actions
 
-This Project uses this custom built action for deploying jekyll to github, available in Marketplace - [Jekyll Deploy Action](https://github.com/marketplace/actions/deploy-jekyll-site)
+This Project has actions to auto deploy jekyll to github pages and firebase. The deployment target can be set by editing the `DEPLOY_STRATEGY` file. Valid values are:
+- `none`: default value. use this if you don't want to deploy the site.
+- `gh-pages`: deploys to github pages. This uses a custom action available in the Marketplace - [Jekyll Deploy Action](https://github.com/marketplace/actions/deploy-jekyll-site)
+- `firebase`: deploys to firebase. Before you can use this you need to first create a firebase project [here](https://console.firebase.google.com/). You can signup for a Free Spark Plan. Then, in your github repo's settings, go to the secrets section and add the following:
+  * `FIREBASE_TOKEN`: your firebase token. you can get this by running `firebase login:ci` with the firebase cli.
+  * `FIREBASE_PROJECT_ID`: the project id of the project you just created
+
 ### Demo (Hosted Apps)
 
 - Github Pages Demo - [here](https://sanketkundu.github.io/)

diff --git a/_config.yml b/_config.yml
@@ -179,6 +179,11 @@ jekyll_admin:
 # Excluded items can be processed by explicitly listing the directories or
 # their entries' file path in the `include:` list.
 
+### Switching Deployment Strategy (in DEPLOY_STRATEGY) file change the key accordingly:
+# none - For no default
+# gh-pages - For Github Pages
+# firebase - For Firebase Hosting
+
 exclude:
   - .sass-cache/
   - .jekyll-cache/