Skip to content

Commit f5f9d59

Browse files
committed
docs: remove bad readme
1 parent 15b1e72 commit f5f9d59

File tree

3 files changed

+10
-21
lines changed

3 files changed

+10
-21
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
coverage/
2-
lib/
2+
dist/
33
node_modules/

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,16 @@
22

33
<p align="center">Security for your Fullstack App 🛡️</p>
44

5-
<p align="center">
6-
<!-- prettier-ignore-start -->
7-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
8-
<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 2" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-2-21bb42.svg" /></a>
9-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
10-
<!-- prettier-ignore-end -->
11-
<a href="https://github.com/atilafassina/shieldwall/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
12-
<a href="https://codecov.io/gh/atilafassina/shieldwall" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/atilafassina/shieldwall?label=%F0%9F%A7%AA%20coverage" /></a>
13-
<a href="https://github.com/atilafassina/shieldwall/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
14-
<a href="http://npmjs.com/package/shieldwall"><img alt="📦 npm version" src="https://img.shields.io/npm/v/shieldwall?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
15-
<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
16-
</p>
5+
## Install
176

18-
## Usage
19-
20-
```shell
21-
npm i shieldwall
7+
```sh
8+
pnpm add shieldwall
229
```
2310

24-
```ts
25-
import { greet } from "shieldwall";
11+
## Usage
2612

27-
greet("Hello, world! 💖");
28-
```
13+
> [!NOTE]
14+
> coming soon
2915
3016
## Contributors
3117

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,8 @@
6969
"peerDependencies": {
7070
"@solidjs/start": "^1.0.8",
7171
"vinxi": "^0.4.3"
72+
},
73+
"publishConfig": {
74+
"provenance": true
7275
}
7376
}

0 commit comments

Comments
 (0)