Adding documentation on README for cdnUrl property

on-the-edge-cloud · Mar 18, 2021 · 2169b09 · 2169b09
1 parent 0f3fb3d
commit 2169b09
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,15 @@ import { CircleFlag } from 'react-circle-flags'
 export const SpanishFlag = () => <CircleFlag countryCode="es" height="35" />
 ```
 
+### With custom CDN
+
+```jsx
+import React from 'react'
+import { CircleFlag } from 'react-circle-flags'
+
+export const SpanishFlag = () => <CircleFlag countryCode="es" height="35" cdnUrl="https://magic-cdn.com/flags/" />
+```
+
 You can pass all the react's `React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>` props to CircleFlag. :rocket:
 
 ## Docs && Gallery