Skip to content

Update library name #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2022
Merged

Update library name #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="logo.svg" width="200" align="center" alt="Typescript Library Logo" style="max-width: 100%;" />
<h1></h1>
<p align="center">
✨ TypeScript Library Description ✨
✨ Your Library Description ✨
</p>
</p>
<br/>
Expand All @@ -13,10 +13,10 @@
<a href="https://opensource.org/licenses/MIT" rel="nofollow">
<img src="https://img.shields.io/github/license/js-templates/typescript-library" alt="License">
</a>
<a href="https://www.npmjs.com/package/typescript-library" rel="nofollow">
<img src="https://img.shields.io/npm/dw/typescript-library.svg" alt="npm">
<a href="https://www.npmjs.com/package/@js-templates/typescript-library" rel="nofollow">
<img src="https://img.shields.io/npm/dw/@js-templates/typescript-library.svg" alt="npm">
</a>
<a href="https://www.npmjs.com/package/typescript-library" rel="nofollow">
<a href="https://www.npmjs.com/package/@js-templates/typescript-library" rel="nofollow">
<img src="https://img.shields.io/github/stars/js-templates/typescript-library" alt="stars">
</a>
</p>
Expand Down Expand Up @@ -46,13 +46,13 @@ Go to [`release/latest`](https://github.com/js-templates/typescript-library/tree
NPM:

```sh
npm install typescript-library
npm install @js-templates/typescript-library
```

Yarn:

```sh
yarn add typescript-library
yarn add @js-templates/typescript-library
```

## Contributing
Expand Down Expand Up @@ -118,9 +118,9 @@ Then, the `release` workflow handles everything:

### Replace everything

1. Replace all `js-templates/typescript-library` entries with your repo
2. Replace all `typescript-library` entries with your library name
3. Replace all `TypeScript Library Description` entries with your library description
1. Replace all `@js-templates/typescript-library` entries with your library name
2. Replace all `js-templates/typescript-library` entries with your repo path
3. Replace all `Your Library Description` entries with your library description
4. Replace all `Your Name` entries with your library name
5. Update `logo.svg`
6. Update logo's `alt`
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "typescript-library",
"name": "@js-templates/typescript-library",
"version": "0.0.0-set-by-ci",
"description": "TypeScript Library Description",
"description": "Your Library Description",
"author": "Your Name",
"main": "dist/index.js",
"exports": "./dist/index.js",
Expand Down