Skip to content

Commit 1f8a017

Browse files
Separated the my-package-name and my-repo-name placeholders
1 parent 1830fc4 commit 1f8a017

File tree

4 files changed

+18
-17
lines changed

4 files changed

+18
-17
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes will be documented in this file.
44
My Project Name adheres to [Semantic Versioning](http://semver.org/).
55

66

7-
[v1.0.0](https://github.com/MyGitHubOrg/my-package-name/tree/v1.0.0) (XXXX-XX-XX)
7+
[v1.0.0](https://github.com/MyGitHubOrg/my-repo-name/tree/v1.0.0) (XXXX-XX-XX)
88
----------------------------------------------------------------------------------------------------
99

1010
Initial release 🎉

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,14 @@ Replace all occurrences of the following placeholders in all files:
3434

3535
|Placeholder |Description
3636
|:----------------------------------|:------------------------------------------------------------
37-
|`MyGitHubOrg` |This is the name of the GitHub org for this repository, such as "JS-DevTools".
38-
|`MyTwitterAccount` |This is the name of the Twitter account associated with this project, such as "JSDevTools".
39-
|`@my-npm-scope` |This is the name of the NPM scope that the package will be published to, such as "@jsdevtools".
40-
|`my-package-name` |This is the name of the NPM package. It should also match the GitHub repo name. It should be kebab-cased.
41-
|`my-cli` |The name of the CLI program for this project, if any.
37+
|`MyGitHubOrg` |The GitHub org for this repository, such as "JS-DevTools".
38+
|`my-repo-name` |The GitHub repo name
39+
|`MyTwitterAccount` |The Twitter account associated with this project, such as "JSDevTools".
40+
|`@my-npm-scope` |The NPM scope that the package will be published to, such as "@jsdevtools".
41+
|`my-package-name` |The NPM package name. It should be kebab-cased.
42+
|`my-cli` |The CLI command for this project, if any.
4243
|`myLibrary` |The name of the library's default export, if any. This should be a valid JavaScript identifier name.
43-
|`My Project Name` |This is the human friendly name of the project that is used in the ReadMe, descriptions, and docs pages
44+
|`My Project Name` |The human friendly name of the project that is used in the ReadMe, descriptions, and docs pages
4445
|`The description of my library` |A short, human friendly description of the project that is used in the ReadMe and package.json
4546

4647

README_md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ My Project Name
22
==============================================
33
### The description of my library
44

5-
[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/MyGitHubOrg/my-package-name/blob/master/.github/workflows/CI-CD.yaml)
6-
[![Build Status](https://github.com/MyGitHubOrg/my-package-name/workflows/CI-CD/badge.svg)](https://github.com/MyGitHubOrg/my-package-name/blob/master/.github/workflows/CI-CD.yaml)
5+
[![Cross-Platform Compatibility](https://jstools.dev/img/badges/os-badges.svg)](https://github.com/MyGitHubOrg/my-repo-name/blob/master/.github/workflows/CI-CD.yaml)
6+
[![Build Status](https://github.com/MyGitHubOrg/my-repo-name/workflows/CI-CD/badge.svg)](https://github.com/MyGitHubOrg/my-repo-name/blob/master/.github/workflows/CI-CD.yaml)
77

8-
[![Coverage Status](https://coveralls.io/repos/github/MyGitHubOrg/my-package-name/badge.svg?branch=master)](https://coveralls.io/github/MyGitHubOrg/my-package-name)
9-
[![Dependencies](https://david-dm.org/MyGitHubOrg/my-package-name.svg)](https://david-dm.org/MyGitHubOrg/my-package-name)
8+
[![Coverage Status](https://coveralls.io/repos/github/MyGitHubOrg/my-repo-name/badge.svg?branch=master)](https://coveralls.io/github/MyGitHubOrg/my-repo-name)
9+
[![Dependencies](https://david-dm.org/MyGitHubOrg/my-repo-name.svg)](https://david-dm.org/MyGitHubOrg/my-repo-name)
1010

1111
[![npm](https://img.shields.io/npm/v/@my-npm-scope/my-package-name.svg)](https://www.npmjs.com/package/@my-npm-scope/my-package-name)
1212
[![License](https://img.shields.io/npm/l/@my-npm-scope/my-package-name.svg)](LICENSE)
13-
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/MyGitHubOrg/my-package-name)
13+
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/MyGitHubOrg/my-repo-name)
1414

1515

1616

@@ -51,13 +51,13 @@ TODO: Document the library's API and CLI usage
5151

5252
Contributing
5353
--------------------------
54-
Contributions, enhancements, and bug-fixes are welcome! [File an issue](https://github.com/MyGitHubOrg/my-package-name/issues) on GitHub and [submit a pull request](https://github.com/MyGitHubOrg/my-package-name/pulls).
54+
Contributions, enhancements, and bug-fixes are welcome! [File an issue](https://github.com/MyGitHubOrg/my-repo-name/issues) on GitHub and [submit a pull request](https://github.com/MyGitHubOrg/my-repo-name/pulls).
5555

5656
#### Building
5757
To build the project locally on your computer:
5858

5959
1. __Clone this repo__<br>
60-
`git clone https://github.com/MyGitHubOrg/my-package-name.git`
60+
`git clone https://github.com/MyGitHubOrg/my-repo-name.git`
6161

6262
2. __Install dependencies__<br>
6363
`npm install`
@@ -74,7 +74,7 @@ License
7474
--------------------------
7575
My Project Name is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
7676

77-
This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/MyGitHubOrg/my-package-name) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
77+
This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/MyGitHubOrg/my-repo-name) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
7878

7979

8080

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
"url": "https://jamesmessinger.com"
99
},
1010
"license": "MIT",
11-
"homepage": "https://jstools.dev/my-package-name",
11+
"homepage": "https://jstools.dev/my-repo-name",
1212
"repository": {
1313
"type": "git",
14-
"url": "https://github.com/MyGitHubOrg/my-package-name.git"
14+
"url": "https://github.com/MyGitHubOrg/my-repo-name.git"
1515
},
1616
"main": "lib/index.js",
1717
"types": "lib/index.d.ts",

0 commit comments

Comments
 (0)