Skip to content

Commit 4ccc1ac

Browse files
committed
update readme
1 parent bad23f7 commit 4ccc1ac

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

.tkb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
"id": "-FlzW8htLo-6jz5-ZqjEx",
2626
"description": "update examples to showcase edge cases",
2727
"columnId": "column-todo"
28+
},
29+
"5fLtFF1sHPxsPjq-wWOxv": {
30+
"id": "5fLtFF1sHPxsPjq-wWOxv",
31+
"description": "Fix turbo-repo template bug - replacing only first doc link in readme --- look at the [doc] with [TypeDoc]",
32+
"columnId": "column-todo"
2833
}
2934
},
3035
"columns": [
@@ -34,7 +39,8 @@
3439
"tasksIds": [
3540
"RtA7NBfPOlfnVHqk54rMD",
3641
"fqhes_YS14GQopOUs7K-7",
37-
"-FlzW8htLo-6jz5-ZqjEx"
42+
"-FlzW8htLo-6jz5-ZqjEx",
43+
"5fLtFF1sHPxsPjq-wWOxv"
3844
]
3945
},
4046
{

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nextjs-Themes-Ultralight
22

3-
[![test](https://github.com/mayank1513/nthul/actions/workflows/test.yml/badge.svg)](https://github.com/mayank1513/nthul/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/mayank1513/nthul/maintainability) [![codecov](https://codecov.io/gh/mayank1513/nthul/graph/badge.svg)](https://codecov.io/gh/mayank1513/nthul) [![Version](https://img.shields.io/npm/v/nthul.svg?colorB=green)](https://www.npmjs.com/package/nthul) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/nthul.svg)](https://www.npmjs.com/package/nthul) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nthul) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
3+
[![test](https://github.com/react18-tools/nthul/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/nthul/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/nthul/maintainability) [![codecov](https://codecov.io/gh/react18-tools/nthul/graph/badge.svg)](https://codecov.io/gh/react18-tools/nthul) [![Version](https://img.shields.io/npm/v/nthul.svg?colorB=green)](https://www.npmjs.com/package/nthul) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/nthul.svg)](https://www.npmjs.com/package/nthul) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nthul) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
44

55
## Features
66

@@ -32,7 +32,7 @@ This template offers following pre-configured features. Additionally, your repo
3232

3333
✅ Workflow to automatically rebrand entire template based on the name of the repo you create from this template. (As soon as you create a repo from this template, setup workflow is triggered which renames nthul to your repo name and does lots of other fixes to set you up and running.)
3434

35-
✅ With all these features, this readme file contains a quick checklist for you to configure Codecov and other badges, setup your docs website on GitHub pages, etc. See [Checklist](https://github.com/mayank1513/nthul/#checklist).
35+
✅ With all these features, this readme file contains a quick checklist for you to configure Codecov and other badges, setup your docs website on GitHub pages, etc. See [Checklist](https://github.com/react18-tools/nthul/#checklist).
3636

3737
#### Create a library that is
3838

@@ -44,7 +44,7 @@ This template offers following pre-configured features. Additionally, your repo
4444

4545
✅ Works with all build systems/tools/frameworks for React18
4646

47-
✅ Doccumented with [Typedoc](https://mayank1513.github.io/nthul) ([Docs](https://react18-tools.github.io/turborepo-template))
47+
✅ Doccumented with [Typedoc](https://react18-tools.github.io/nthul) ([Docs](https://react18-tools.github.io/nthul))
4848

4949
## Install
5050

@@ -86,7 +86,7 @@ $ yarn add nthul
8686
- [ ] Create your library and update examples
8787
- [ ] Update README
8888
- [ ] Setup GitHub pages to deploy docs
89-
- [ ] Go to [repo settings](https://github.com/mayank1513/nthul/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
89+
- [ ] Go to [repo settings](https://github.com/react18-tools/nthul/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
9090
- [ ] Push your changes/Create PR and see your library being automatically tested and published
9191
- [ ] Optionally deploy your example(s) to Vercel.
9292
- [ ] You are most welcome to star this template, contribute, and/or sponsor the `terbo-repo-template` project or my other open-source work
@@ -144,7 +144,7 @@ Learn more about the power of Turborepo:
144144
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
145145
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
146146

147-
### 🤩 Don't forger to start [this repo](https://github.com/mayank1513/nthul)!
147+
### 🤩 Don't forger to start [this repo](https://github.com/react18-tools/nthul)!
148148

149149
Want hands-on course for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScrypt](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE)
150150

0 commit comments

Comments
 (0)