add example project & readme adjustments

Author: bmstefanski

README.md

@@ -5,8 +5,8 @@
 </div>
 
 <div align="center">
-  <a href="https://www.npmjs.com/package/next-image-proxy"><img alt="npm version badge" src="https://img.shields.io/npm/v/next-image-proxy"></a>
-  <img alt="license badge" src="https://img.shields.io/npm/l/next-image-proxy">
+  <a href="https://www.npmjs.com/package/@blazity/next-image-proxy"><img alt="npm version badge" src="https://img.shields.io/npm/v/@blazity/next-image-proxy"></a>
+  <img alt="license badge" src="https://img.shields.io/npm/l/@blazity/next-image-proxy">
 </div>
 
 <br />
@@ -25,11 +25,11 @@ You have to remember that there're some cons:
 ## 🧰 Installation
 
 ```
-$ npm i --save next-image-proxy
+$ npm i --save @blazity/next-image-proxy
 
 # or
 
-$ yarn add next-image-proxy
+$ yarn add @blazity/next-image-proxy
 ```
 
 ## 💻 Use
@@ -39,20 +39,21 @@ It is really simple to setup, you just need to add a new API route that exports
 ```tsx
 // pages/api/imageProxy.ts
 
-import { withImageProxy } from 'next-image-proxy'
+import { withImageProxy } from '@blazity/next-image-proxy'
 
-export default withImageProxy({ whitelistedPatterns: [/medium.com/] })
+export default withImageProxy({ whitelistedPatterns: [/^https?:\/\/(.*).medium.com/] })
 ```
 
 and now you prefix the image you want to use:
 
 ```tsx
 import NextImage from 'next/image'
 
-{
-  /* O.F.C. */
+export function SomeComponent() {
+  const actualImageUrl = 'https://cdn-images-1.medium.com/max/1024/1*xYoAR2XRmoCmC9SONuTb-Q.png'
+
+  return <NextImage src={`/api/imageProxy?imageUrl=${actualImageUrl}`} width={700} height={300} />
 }
-return <NextImage src={`api/imageProxy?imageUrl=${originalUrl}`} />
 ```
 
 ## 🤲🏻 Contributing

example/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

example/.gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

example/README.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

example/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

example/next.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  reactStrictMode: true,
+}

example/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "example",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@blazity/next-image-proxy": "1.0.1",
+    "next": "12.1.0",
+    "react": "17.0.2",
+    "react-dom": "17.0.2"
+  },
+  "devDependencies": {
+    "eslint": "8.10.0",
+    "eslint-config-next": "12.1.0"
+  }
+}

example/pages/api/imageProxy.ts

@@ -0,0 +1,3 @@
+import { withImageProxy } from '@blazity/next-image-proxy'
+
+export default withImageProxy({ whitelistedPatterns: [/^https?:\/\/(.*).medium.com/] })

example/pages/index.tsx

@@ -0,0 +1,23 @@
+import NextImage from 'next/image'
+
+export default function Homepage() {
+  return (
+    <>
+      <NextImage
+        src="/api/imageProxy?imageUrl=https://cdn-images-1.medium.com/max/1024/1*xYoAR2XRmoCmC9SONuTb-Q.png"
+        width={700}
+        height={300}
+      />
+      <NextImage
+        src="/api/imageProxy?imageUrl=https://cdn-images-1.medium.com/max/300/1*TOh1Ybtg_AmyvhA9Dgc65Q.png"
+        width={700}
+        height={300}
+      />
+      <NextImage
+        src="/api/imageProxy?imageUrl=https://cdn-images-1.medium.com/max/287/1*ObtObJyNveLZtKF4eTgeLw.png"
+        width={700}
+        height={300}
+      />
+    </>
+  )
+}