Skip to content

Commit

Permalink
docs: update README (#43)
Browse files Browse the repository at this point in the history
* docs: update README

* docs: replace github repo name
  • Loading branch information
ZLY201 committed Jun 7, 2024
1 parent 7710728 commit 5a6f2ce
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 16 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Typescript-Tutorial-Exercises Contributing Guide
# Type-Challenges-Site Contributing Guide

Hi! I'm really excited that you are interested in contributing to js-sdsl. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

- [Code of Conduct](https://github.com/typescript-tutorial-exercises/core/blob/main/CODE_OF_CONDUCT.md)
- [Code of Conduct](https://github.com/type-challenges/site/blob/main/CODE_OF_CONDUCT.md)
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
Expand Down Expand Up @@ -44,7 +44,7 @@ $ yarn setup

### Committing Changes

Please follow the commit specification. See [`.commitlintrc.json`](https://github.com/typescript-tutorial-exercises/core/blob/main/.commitlintrc.json) get help.
Please follow the commit specification. See [`.commitlintrc.json`](https://github.com/type-challenges/site/blob/main/.commitlintrc.json) get help.

### Commonly used NPM scripts

Expand All @@ -68,6 +68,6 @@ All our source files are written in typescript, please make sure your submission

## Credits

Thank you to all the people who have already contributed to `typescript-tutorial-exercises`!
Thank you to all the people who have already contributed to `type-challenges`!

[![contributors](https://contrib.rocks/image?repo=typescript-tutorial-exercises/core)](https://github.com/typescript-tutorial-exercises/core/graphs/contributors)
[![contributors](https://contrib.rocks/image?repo=type-challenges/site)](https://github.com/type-challenges/site/graphs/contributors)
1 change: 0 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# These are supported funding model platforms

open_collective: typescript-tutorial-exercises
custom: ["https://www.paypal.com/paypalme/zly201"]
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ jobs:
folder: dist
branch: gh-pages
token: ${{ secrets.DEPLOY_TOKEN }}
repository-name: typescript-tutorial-exercises/preview
repository-name: type-challenges/site
- name: Deploy to github pages
if: ${{ github.ref == 'refs/heads/main' }}
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: dist
branch: gh-pages
token: ${{ secrets.DEPLOY_TOKEN }}
repository-name: typescript-tutorial-exercises/typescript-tutorial-exercises.github.io
repository-name: type-challenges/type-challenges.github.io
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Typescript Tutorial Exercise

[![status](https://img.shields.io/github/actions/workflow/status/typescript-tutorial-exercises/core/deploy.yml)](https://github.com/typescript-tutorial-exercises/core/actions/workflows/deploy.yml)
[![stars](https://img.shields.io/github/stars/typescript-tutorial-exercises/core.svg)](https://github.com/typescript-tutorial-exercises/core)
[![status](https://img.shields.io/github/actions/workflow/status/type-challenges/site/deploy.yml)](https://github.com/type-challenges/site/actions/workflows/deploy.yml)
[![stars](https://img.shields.io/github/stars/type-challenges/site.svg)](https://github.com/type-challenges/site)
[![licenses](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![language](https://img.shields.io/github/languages/top/typescript-tutorial-exercises/core.svg)](https://github.com/typescript-tutorial-exercises/core)
[![language](https://img.shields.io/github/languages/top/type-challenges/site.svg)](https://github.com/type-challenges/site)

## Getting Started

Please go to [typescript-tutorial-exercises.github.io](https://typescript-tutorial-exercises.github.io/) to start your TypeScript travel!
Please go to [type-challenges.github.io](https://type-challenges.github.io/) to start your TypeScript travel!

All exercises are from [type-challenges](https://github.com/type-challenges/type-challenges).

Expand All @@ -19,7 +19,7 @@ Feel free to dive in! Open an issue or submit PRs. It may be helpful to read the

Thanks goes to these wonderful people:

[![contributors](https://contrib.rocks/image?repo=typescript-tutorial-exercises/core)](https://github.com/typescript-tutorial-exercises/core/graphs/contributors)
[![contributors](https://contrib.rocks/image?repo=type-challenges/site)](https://github.com/type-challenges/site/graphs/contributors)


## License
Expand Down
2 changes: 1 addition & 1 deletion config/links.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"github-repo": "https://github.com/typescript-tutorial-exercises"
"github-repo": "https://github.com/type-challenges/site"
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "typescript-tutorial-exercises",
"name": "type-challenges-site",
"version": "1.0.0",
"author": {
"name": "ZLY201",
Expand Down
2 changes: 1 addition & 1 deletion src/modules/Footer/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const Footer = function () {
return (
<div className={styles.container}>
<a href={linkJson['github-repo']} target={'_blank'} rel="noreferrer">
copyright © 2023-{dayjs().year()} typescript-tutorial-exercises
copyright © 2023-{dayjs().year()} Type Challenges
</a>
</div>
);
Expand Down

0 comments on commit 5a6f2ce

Please sign in to comment.