remove outdated development setup and publishing instructions from README
Some checks are pending
CI / build-and-publish (push) Waiting to run
Some checks are pending
CI / build-and-publish (push) Waiting to run
This commit is contained in:
parent
9af90aa4cc
commit
76f2df3756
1 changed files with 0 additions and 43 deletions
43
README.md
43
README.md
|
@ -60,46 +60,3 @@ async function example() {
|
||||||
## Supported Formats
|
## Supported Formats
|
||||||
|
|
||||||
- .png, .jpg, .jpeg, .gif, .bmp, .webp, .tiff
|
- .png, .jpg, .jpeg, .gif, .bmp, .webp, .tiff
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
### Setup
|
|
||||||
|
|
||||||
1. Clone the repository
|
|
||||||
2. Install dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Scripts
|
|
||||||
|
|
||||||
- `npm run build`: Compile TypeScript
|
|
||||||
- `npm run lint`: Run ESLint
|
|
||||||
- `npm test`: Run Jest tests
|
|
||||||
- `npm run test:coverage`: Run tests with coverage report
|
|
||||||
|
|
||||||
### Publishing to NPM
|
|
||||||
|
|
||||||
1. Ensure you're logged into NPM:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm login
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Update version (use appropriate semver):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm version patch # or minor/major
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Publish:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm publish
|
|
||||||
```
|
|
||||||
|
|
||||||
### Continuous Integration
|
|
||||||
|
|
||||||
- Ensure `.github/workflows/ci.yml` is set up for automated testing
|
|
||||||
- Configure NPM token in repository secrets
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue