diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b75b39..56d39f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,24 +57,6 @@ Here's a small list of requirements for your PR: - PR must have a clear description of what it does, which part of the repo it affects - if PR is adding a new middleware, it should have an example in the description. -### Adding new example - -- Create a folder with the package name in `examples` folder -- Create `package.json` with these fields: - -```json -{ - "name": "", - "type": "module", - "module": "index.js" -} -``` - -- create `index.js` (or `index.ts`) file -- create some cool example -- create `README.md` with example title and setup instructions (copy from any near folder and replace needed fields) -- Pull request! - In most other cases, additional steps aren't required. Install, write, test, lint and your code is ready to be submitted! If everything from the list is done right, feel free to submit a PR! I will look into it asap. diff --git a/README.md b/README.md index 2f65985..fb6fe62 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Malibu

-[![npm](https://img.shields.io/npm/v/malibu?style=for-the-badge&logo=npm&label=&color=26B0A0)](https://npmjs.com/package/malibu) [![npm](https://img.shields.io/npm/dt/malibu?style=for-the-badge&color=26B0A0)](https://npmjs.com/package/malibu) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/tinyhttp/malibu/CI?label=&logo=github&style=for-the-badge&color=26B0A0)](https://github.com/tinyhttp/malibu/actions) [![Codecov](https://img.shields.io/coveralls/github/tinyhttp/malibu?style=for-the-badge&color=26B0A0)](https://coveralls.io/github/tinyhttp/malibu) +[![npm](https://img.shields.io/npm/v/malibu?style=for-the-badge&logo=npm&label=&color=26B0A0)](https://npmjs.com/package/malibu) [![npm](https://img.shields.io/npm/dt/malibu?style=for-the-badge&color=26B0A0)](https://npmjs.com/package/malibu) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/tinyhttp/malibu/CI?label=&logo=github&style=for-the-badge&color=26B0A0)](https://github.com/tinyhttp/malibu/actions) [![Coveralls](https://img.shields.io/coveralls/github/tinyhttp/malibu?style=for-the-badge&color=26B0A0)](https://coveralls.io/github/tinyhttp/malibu) @@ -84,7 +84,7 @@ app.post('/', csrfProtection, (req, res) => { }) ``` -For other framework appliances, please refer to [examples](https://github.com/tinyhttp/malibu/tree/master/examples) +For detailed example, please refer to [examples](https://github.com/tinyhttp/tinyhttp/tree/master/examples/csrf) ## Options diff --git a/package.json b/package.json index 6707060..22a29be 100644 --- a/package.json +++ b/package.json @@ -34,8 +34,7 @@ "homepage": "https://github.com/tinyhttp/malibu#readme", "directories": { "test": "./test", - "lib": "./src", - "example": "./examples" + "lib": "./src" }, "engines": { "node": "^12.20.0 || ^14.13.1 || >=16.0.0"