Merge pull request #2 from triyanox/fix/fix-readme

fix: fix readme and MIT license

.changeset/silent-books-fry.md

@@ -0,0 +1,5 @@
+---
+"cronbake": patch
+---
+
+Add license and fix readme

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mohamed Achaq
+
+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.

README.md

@@ -99,7 +99,7 @@ You can manage cron jobs using the various methods provided by the `Baker` class
 Cronbake also provides a `Cron` class that you can use directly to create and manage individual cron jobs. This can be useful if you need more granular control over cron job instances.
 
 ```typescript
-import Cron from 'cronbake';
+import { Cron } from 'cronbake';
 
 // Create a new Cron instance
 const job = Cron.create({
@@ -134,7 +134,7 @@ const nextExecution = job.nextExecution();
 Cronbake also provides utility functions for parsing cron expressions, getting the next or previous execution times, and validating cron expressions.
 
 ```typescript
-import Cron from 'cronbake';
+import { Cron } from 'cronbake';
 
 // Parse a cron expression
 const cronTime = Cron.parse('0 0 * * 0 *');
@@ -149,12 +149,10 @@ const previousExecution = Cron.getPrevious('0 0 * * 0 *');
 const isValid = Cron.isValid('0 0 * * 0 *'); // true
 ```
 
-For more advanced usage and examples, please refer to the [Documentation](link-to-documentation).
-
 ## Contributing
 
 Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
 
 ## License
 
-Cronbake is released under the [MIT License](link-to-license).
+Cronbake is released under the [MIT License](./LICENSE).