From 5bb542459c8ec59522eefd0c2c0b31c5b4fa831e Mon Sep 17 00:00:00 2001 From: M A Alim Date: Thu, 25 May 2023 12:52:23 +0600 Subject: [PATCH] add license and readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b69fa0b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 M A Alim + +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. \ No newline at end of file diff --git a/README.md b/README.md index e69de29..fae8480 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,38 @@ +# react-awesome-clock + +This repository contains simple analog clock to be used in React applications. You can either use the live clock or set +your given time to see a stationary clock. + +## To run in development + +```bash +npm run dev +``` + +## To run tests + +```bash +npm test +``` + +or + +```bash +npm run watch +``` + +## To build and publish + +```bash +npm run build +``` + +followed by + +```bash +npm publish +``` + +## License + +MIT © [alim1496](https://github.com/alim1496)