Merge branch 'main' of https://github.com/maheshmb13/S-Crop

README.md

@@ -0,0 +1,146 @@
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/maheshmb13/S-Crop">
+    <img src="images/S-logos.jpeg" alt="Logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">S-Crop</h3>
+
+  <p align="center">
+    Snipping tool with OCR feature - Built with Electron.
+    <br />
+    <a href="https://github.com/maheshmb13/S-Crop/releases/"><strong>Download the desktop application now »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/maheshmb13/S-Crop/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/maheshmb13/S-Crop/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open="open">
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li>Working with code</li>
+        <li>Installation & Usage</li>
+      </ul>
+    </li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgements">Acknowledgements</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+[![Product Name Screen Shot][product-screenshot]](https://example.com)
+
+Tired of making a doc or taking notes? <br/>
+S-Crop all-in-one snipping tool with OCR feature. Easily invoke using keyboard shortcuts. Select and copy the desired area of the screen easily to your clipboard. Also, extract the text from the selected area. Everything is copied to your clipboard. Make docs in a hassle free process.
+
+Here's why:
+* Handling images while making a doc is difficult.
+* Each time you need to take a screenshot, insert it into the doc and crop the desired area.
+* So, S-Crop simplifies the task by simply copying the desired area to your clipboard
+
+### Built With
+
+* [Electron](https://www.electronjs.org/)
+* [JCrop](https://jcrop.com/)
+* [Tesseract.js](https://tesseract.projectnaptha.com/)
+* [NodeJs](https://nodejs.org/en/)
+* [Electron-Builder](https://www.electron.build/)
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+<b>[Download the desktop setup from here >>](https://github.com/maheshmb13/S-Crop/releases/) </b>
+
+### To use the code:
+
+* Install the node modules using yarn command
+  ```sh
+  yarn
+  ```
+* To initiate the development process
+  ```sh
+  yarn start
+  ```
+* To distribute the application using electron-build
+  ```sh
+  yarn add [email protected] --dev
+
+  yarn distribute
+  ```
+
+
+### Installation & Usage
+
+1. Download the desktop application setup [here](https://github.com/maheshmb13/S-Crop/releases/)
+2. Change the directory. Do not use default C directory to install the application, as this may lead to permission issues. Use D:/ or E:/ directories. Create a folder named S-Crop in any one of directory. Give this path during installation.
+3. Install the application and you are all set.
+4. There are currently two features: <br/><br/>
+    <b>SNIP</b> <br/>
+    Crop the desired area of the screen and copy it to the clipboard.
+    <br/><br/>
+    <b> OCR </b> <br/>
+    Extract text from the desired area of the screen and copy it to the clipboard.
+    <br/><br/>
+    • Select the desired rectangle. The result will be copied to the clipboard.
+    <br/><br/>
+    Keyboard Shorcuts:
+   ```Keyboard shortcuts
+   SNIP: CTRL+ALT+I
+   OCR: CTRL+ALT+O
+   Close the current cropping window: Press Esc
+   ```
+
+
+<!-- CONTACT -->
+## Contact
+
+[Linkedin](https://linkedin.com/in/maheshmb13) - (https://linkedin.com/in/maheshmb13) <br/> 
+
+Project Link: [https://github.com/maheshmb13/S-Crop](https://github.com/maheshmb13/S-Crop)
+
+
+
+<!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+* [JCrop](https://jcrop.com/)
+* [Electron](https://www.electronjs.org/)
+* [Tesseract.js](https://tesseract.projectnaptha.com/)
+* [Nodejs](https://nodejs.org/en/)
+* [Electron-Builder](https://www.electron.build/)
+* [Readme Template](https://github.com/othneildrew/Best-README-Template)
+
+
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/maheshmb13
+[product-screenshot]: images/screenshot.png