Skip to content

Commit

Permalink
Add readme, update build config
Browse files Browse the repository at this point in the history
  • Loading branch information
xyTom committed Apr 22, 2024
1 parent 9735bd7 commit ba76845
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 4 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
![Snippai Banner](https://im.gurl.eu.org/file/ed3d8ebfbe90720074b92.png)

# Snippai: AI-Powered Snipping Tool

Snippai is a versatile and intelligent snipping tool powered by advanced AI algorithms. It offers a range of features to enhance your snipping experience, making it more efficient and productive. From identifying formulas and text within images to analyzing and describing the content of images, Snippai brings a new level of intelligence to snipping tools.

## Features

### Formula Recognition
Snippai can identify formulas within images and convert them into LaTeX format, making it easier to work with mathematical expressions.

### Text Extraction
Accurately recognize and extract text from images, enabling seamless integration of textual content into your workflow.

### Table Conversion
Identify tables within images and convert them into user-friendly Markdown format, facilitating easier data manipulation and analysis.

### Image Analysis
Analyze and describe the content of an image, providing valuable insights and information about visual elements.

### Problem Solving
Solve various problems presented within images, leveraging AI capabilities to assist with tasks such as object recognition and pattern identification.

### Code Understanding
Understand and explain the functionality of code snippets found in images, helping users comprehend and work with code more effectively.

### Color Detection
Identify and extract the predominant colors in an image, useful for tasks such as design analysis and image processing.

### And More...
Stay tuned for more powerful AI capabilities coming soon! Snippai is continuously evolving to offer new features and enhancements to improve your snipping workflow.

## Download and Installation

You can download Snippai from [here](https://github.com/xyTom/snippai/releases), and detailed installation instructions are available in the documentation.

## Usage

To use Snippai, simply open the application and capture the desired region of your screen using the snipping tool. Snippai will automatically analyze the captured image and provide relevant insights and conversions based on the detected elements.

## Contributing

Contributions to Snippai are welcome! Whether you're interested in adding new features, improving existing functionalities, or fixing bugs, your contributions are valuable in making Snippai even better. Please refer to the contribution guidelines in the repository for more information.

## Support

For any questions, issues, or feedback, please contact us at [[email protected]](mailto:[email protected]). We're here to help!

## Acknowledgments

Snippai utilizes various open-source libraries and technologies, and we would like to extend our gratitude to the developers and contributors of these projects.

---

Enjoy smarter snipping with Snippai! ;)
2 changes: 1 addition & 1 deletion forge.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const config: ForgeConfig = {
asar: true,
},
rebuildConfig: {},
makers: [new MakerSquirrel({}), new MakerZIP({}, ['win32']), new MakerRpm({}), new MakerDeb({})],
makers: [new MakerSquirrel({}), new MakerZIP({}, ['win32','darwin']), new MakerRpm({}), new MakerDeb({})],
plugins: [
new VitePlugin({
// `build` can specify multiple entry builds, which can be Main process, Preload scripts, Worker process, etc.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "snippai",
"productName": "Snippai",
"version": "1.0.0",
"version": "0.1.0",
"description": "A snipping app with AI",
"main": ".vite/build/main.js",
"scripts": {
Expand Down

0 comments on commit ba76845

Please sign in to comment.