diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index ef29b36..dd3ae99 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1,3 +1,3 @@
# These are supported funding model platforms
-patreon: alexskrypnyk
+patreon: yournamespace
diff --git a/README.md b/README.md
index 06290a2..fc29beb 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,15 @@
# Scaffold
-Generic project scaffold template
+Generic project yourproject template
[//]: # (#;< META)
+
-
-
- META: How to use this scaffold repository |
-
-
- 1. Click on Use this template > Create a new repository |
- → |
- 2. Checkout locally and run ./init.sh |
- → |
- 3. Adjust this README.md as required |
-
-
- The content of this README.md file will be a part of your repository. |
-
-
+| **META: How to use this scaffold repository** |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1. Click on **Use this template** > **Create a new repository**
2. Checkout locally
3. Run `./init.sh` to replace `yournamespace`, `yourproject`, `Your Name` strings with your own |
+| The contents below will be a part of your repository. |
+
[//]: # (#;> META)
@@ -33,41 +24,47 @@ Generic project scaffold template
- Your third feature as a list item
## Installation
+
[//]: # (#;< COMPOSER)
-
- composer require alexskrypnyk/scaffold
-
+
+ composer require yournamespace/yourproject
+
[//]: # (#;> COMPOSER)
+
[//]: # (#;< NODEJS)
-
- npm install @alexskrypnyk/scaffold
-
+
+ npm install @yournamespace/yourproject
+
[//]: # (#;> NODEJS)
## Usage
+
[//]: # (#;< COMPOSER)
- vendor/bin/scaffold
-
+ vendor/bin/yourproject
+
[//]: # (#;> COMPOSER)
+
[//]: # (#;< NODEJS)
- node_modules/.bin/scaffold
-
+ node_modules/.bin/yourproject
+
[//]: # (#;> NODEJS)
## Maintenance
+
[//]: # (#;< COMPOSER)
composer install
composer lint
composer test
-
+
[//]: # (#;> COMPOSER)
+
[//]: # (#;< NODEJS)
npm install
npm run lint
npm run test
-
+
[//]: # (#;> NODEJS)
diff --git a/composer.json b/composer.json
index 95cd5e1..b7847c8 100644
--- a/composer.json
+++ b/composer.json
@@ -1,20 +1,20 @@
{
- "name": "alexskrypnyk/scaffold",
+ "name": "yournamespace/yourproject",
"type": "library",
- "description": "Provides scaffold functionality.",
+ "description": "Provides yourproject functionality.",
"license": "GPL-2.0-or-later",
"authors": [
{
- "name": "Alex Skrypnyk",
- "email": "alex@drevops.com",
- "homepage": "https://alexskrypnyk.com",
+ "name": "Your Name",
+ "email": "yourproject@yournamespace.com",
+ "homepage": "https://yournamespace.com",
"role": "Maintainer"
}
],
- "homepage": "https://github.com/alexskrypnyk/scaffold",
+ "homepage": "https://github.com/yournamespace/yourproject",
"support": {
- "issues": "https://github.com/alexskrypnyk/scaffold/issues",
- "source": "https://github.com/alexskrypnyk/scaffold"
+ "issues": "https://github.com/yournamespace/yourproject/issues",
+ "source": "https://github.com/yournamespace/yourproject"
},
"require": {},
"scripts": {
diff --git a/init.sh b/init.sh
index a8f9a50..f92529c 100755
--- a/init.sh
+++ b/init.sh
@@ -7,7 +7,7 @@
# ./init
#
# Silent:
-# ./init yournamespace yourproject "your name"
+# ./init yournamespace yourproject "Your Name"
#
# shellcheck disable=SC2162
@@ -71,10 +71,11 @@ remove_nodejs() {
[ "$usecomposer" != "y" ] && remove_composer
[ "$usenodejs" != "y" ] && remove_nodejs
-replace_string_content "alexskrypnyk" "$namespace"
+replace_string_content "yournamespace" "$namespace"
+replace_string_content "yournamespace" "$namespace"
replace_string_content "AlexSkrypnyk" "$namespace"
-replace_string_content "scaffold" "$project"
-replace_string_content "Alex Skrypnyk" "$author"
+replace_string_content "yourproject" "$project"
+replace_string_content "Your Name" "$author"
remove_tokens_with_content "META"
remove_special_comments
diff --git a/package.json b/package.json
index ece4aff..904372e 100644
--- a/package.json
+++ b/package.json
@@ -1,16 +1,16 @@
{
- "name": "@alexskrypnyk/scaffold",
+ "name": "@yournamespace/yourproject",
"version": "0.1.0",
- "description": "Provides scaffold functionality.",
+ "description": "Provides yourproject functionality.",
"license": "GPL-2.0-or-later",
"author": {
- "name": "Alex Skrypnyk",
- "email": "alex@drevops.com",
- "url": "https://alexskrypnyk.com"
+ "name": "Your Name",
+ "email": "yourproject@yournamespace.com",
+ "url": "https://yournamespace.com"
},
"contributors": [],
- "repository": "github:alexskrypnyk/scaffold",
- "bugs": "https://github.com/alexskrypnyk/scaffold/issues",
+ "repository": "github:yournamespace/yourproject",
+ "bugs": "https://github.com/yournamespace/yourproject/issues",
"directories": {
"test": "tests"
},