From a4ff23e55837d224d89ddd98c2b5a6331e2b05e6 Mon Sep 17 00:00:00 2001 From: Abhinandan Wadhwa <74089487+abhinandanwadwa@users.noreply.github.com> Date: Mon, 12 Dec 2022 10:33:34 +0530 Subject: [PATCH 1/2] Added a License for the package --- LICENSE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..25726be --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Abhinandan Wadhwa + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 59d75e0afd77aad29c2e65e271ba38ef9f41f663 Mon Sep 17 00:00:00 2001 From: Abhinandan Wadhwa <74089487+abhinandanwadwa@users.noreply.github.com> Date: Mon, 12 Dec 2022 10:51:48 +0530 Subject: [PATCH 2/2] update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 464b7aa..65c94cd 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# image-color-extractor-npm-package +# Image-Color-Extractor + + +🎉 Image-Color-Extractor allows you to extract color from images and use it in your app with ease. No more nonsense! + +## Installation + +``` +$ npm install image-color-extractor +``` + +## The gist + +```jsx + import React from 'react'; + import { useEffect } from 'react'; + + import extractSingleColor from 'image-color-extractor'; + + function App(){ + useEffect(() => { + extractSingleColor(imageURI) + .then(color => console.log(color)) + .catch(error => console.error(error)) + }, []); + + return ( +
+ +
+ ); + } +``` + +## Contribute + +Show your ❤️ and support by giving a ⭐. Any suggestions are welcome! Take a look at the contributing guide. + +## Release Notes + +You can find the release note for the latest release [here](https://github.com/abhinandanwadwa/image-color-extractor-npm-package/releases/latest) + +You can browse them all [here](https://github.com/abhinandanwadwa/image-color-extractor-npm-package/releases) + +## License + +Licensed under MIT