summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Ditton <jditton.atomic@gmail.com>2021-12-04 17:04:11 -0700
committerJoseph Ditton <jditton.atomic@gmail.com>2021-12-04 17:04:11 -0700
commit977854867d2f2cad053b54e24df027d7de7fb538 (patch)
treef0f4de57f5709e4297c1af824dfdf42565e7388f
parentc8339e42f7be13616371365eb27fb8d4c30f6d5c (diff)
downloadlocchat-977854867d2f2cad053b54e24df027d7de7fb538.tar.gz
locchat-977854867d2f2cad053b54e24df027d7de7fb538.zip
updates readme and setup script
-rw-r--r--README.md5
-rw-r--r--bin/setup_new_project.sh1
2 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index d41d9ad..c03f228 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
# USU CS4610 Nest Starter App
+<!-- BEGIN REMOVABLE -->
## Description
A starter app with Postgres, NestJS, and React
@@ -22,6 +23,10 @@ $ bash ./bin/setup_new_project.sh
```
and follow the prompts. This script will link the repo to your new repo while maintaining a reference to the starter app repo. This way, if we make changes to the starter app repo, you can still get those changes.
+<!-- END REMOVABLE -->
+
+## Pulling Updates from Starter App
+
To retrieve changes from the starter app run
```bash
$ git pull upstream main
diff --git a/bin/setup_new_project.sh b/bin/setup_new_project.sh
index 734b139..ac0095b 100644
--- a/bin/setup_new_project.sh
+++ b/bin/setup_new_project.sh
@@ -9,6 +9,7 @@ read reponame
# replace the title of the README with new app name
sed -i "s/USU CS4610 Nest Starter App/$appname/" README.md
+sed -i "s/<!-- BEGIN REMOVABLE -->.*<!-- END REMOVABLE -->/$appname/" README.md
git add .
git commit -m "setup new project '$appname'"