Skip to content

Commit 69dedd4

Browse files
authored
Shared configs readmeupdates (#99)
* update template readme * update badges
1 parent e92e8b6 commit 69dedd4

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

.template/shared/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# <<packagename>>
1+
# <<packagename>> ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Finstructure%2Finstructure.ai%2Frefs%2Fheads%2Fmain%2Fpackages%2F<<cliname>>%2Fpackage.json&query=%24.version&label=version&labelColor=%230e1721&color=%234279B6)
22

3-
## Installation
4-
5-
```shell
6-
pnpm add <<packagename>>
7-
```
3+
...

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
> [!WARNING]
22
> Commits to `main` trigger builds & deploys to [instructure.ai](https://instructure.ai/). Use pull requests to update packages.
33
4-
# @instructure.ai/shared-configs ![GitHub package.json dynamic](https://img.shields.io/github/package-json/version/instructure/instructure.ai?labelColor=%230E1721&color=%234279B6) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/deploy-static.yml?labelColor=%230E1721)
4+
# @instructure.ai/shared-configs
5+
6+
![Version](https://img.shields.io/github/package-json/version/instructure/instructure.ai?labelColor=%230E1721&color=%234279B6) ![NPM Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/release-package.yml?logo=npm&logoColor=%23CB3837&label=package%20builds&labelColor=%230E1721) ![Web Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/deploy-apps.yml?logo=javascript&logoColor=%23F7DF1E&label=web%20builds&labelColor=%230E1721)
7+
58

69
This is a monorepo of apps and packages. Apps are served on [instructure.ai](https://instructure.ai)
710

scripts/new.mts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,12 @@ async function main() {
104104
FULLPACKAGENAME,
105105
);
106106

107+
await replaceInFile(
108+
path.join(pkgDir, "README.md"),
109+
CLINAME,
110+
PACKAGENAME,
111+
);
112+
107113
if (TEMPLATE === "instui") {
108114
const url = "https://instructure.design/llms.txt";
109115
let guidelines = "";

0 commit comments

Comments
 (0)