Skip to content

Commit 85ce46e

Browse files
committed
docs: move deprecation notice and add coverage badges
- Move DEPRECATION_react-code-view.md to docs/ - Update NPM deprecation commands - Add Codecov badge to README top and normalize badges - Clean up coverage summary docs
1 parent 3b9ec9c commit 85ce46e

File tree

4 files changed

+7
-213
lines changed

4 files changed

+7
-213
lines changed

NPM_DEPRECATION_COMMANDS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ After merging the PR that removes the `react-code-view` package, run the followi
88

99
```bash
1010
# Deprecate all versions of react-code-view
11-
npm deprecate react-code-view "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/DEPRECATION_react-code-view.md for migration guide."
11+
npm deprecate react-code-view "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/docs/DEPRECATION_react-code-view.md for migration guide."
1212
```
1313

1414
### Deprecate specific version ranges (alternative)
@@ -17,10 +17,10 @@ If you prefer to deprecate specific versions:
1717

1818
```bash
1919
# Deprecate v3.x versions
20-
npm deprecate react-code-view@3.x "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/DEPRECATION_react-code-view.md for migration guide."
20+
npm deprecate react-code-view@3.x "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/docs/DEPRECATION_react-code-view.md for migration guide."
2121

2222
# Deprecate v2.x versions (if needed)
23-
npm deprecate react-code-view@2.x "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/DEPRECATION_react-code-view.md for migration guide."
23+
npm deprecate react-code-view@2.x "Package deprecated. Please use @react-code-view/react instead. See https://github.com/simonguo/react-code-view/blob/main/docs/DEPRECATION_react-code-view.md for migration guide."
2424
```
2525

2626
## 📋 Verification
@@ -44,4 +44,4 @@ You should see a deprecation warning in the output.
4444

4545
- npm deprecate documentation: https://docs.npmjs.com/cli/v10/commands/npm-deprecate
4646
- npm unpublish policy: https://docs.npmjs.com/policies/unpublish
47-
- Migration guide: [DEPRECATION_react-code-view.md](./DEPRECATION_react-code-view.md)
47+
- Migration guide: [docs/DEPRECATION_react-code-view.md](./docs/DEPRECATION_react-code-view.md)

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# React Code View
22

3-
[![npm](https://img.shields.io/npm/v/react-code-view.svg)](https://www.npmjs.com/package/react-code-view)
4-
[![npm](https://img.shields.io/npm/dm/react-code-view.svg)](https://www.npmjs.com/package/react-code-view)
3+
[![npm](https://img.shields.io/npm/v/@react-code-view/react.svg)](https://www.npmjs.com/package/@react-code-view/react)
4+
[![npm](https://img.shields.io/npm/dm/@react-code-view/react.svg)](https://www.npmjs.com/package/@react-code-view/react)
5+
[![codecov](https://codecov.io/gh/simonguo/react-code-view/branch/main/graph/badge.svg)](https://codecov.io/gh/simonguo/react-code-view)
56
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
67

78
A React component library for rendering code with **live preview** and syntax highlighting.

TEST_COVERAGE_SUMMARY.md

Lines changed: 0 additions & 207 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)