diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
deleted file mode 100644
index 5fc28481..00000000
--- a/.github/CODEOWNERS
+++ /dev/null
@@ -1,28 +0,0 @@
-# ---------- Our awesome maintainers ----------
-
-# Global maintainers
-* @Mathys-Gasnier
-
-# Code maintainers
-/src/ @psychlone77 @saminjay
-
-# Snippets maintainers
-/snippets @Mathys-Gasnier
-
-
-# ---------- What is a maintainer ----------
-
-# Maintainers will be notified when there is a pull request
-# with a change in the folder/file assigned to them. They will
-# have to approve the pull request before it can be merged.
-
-
-# ---------- How to be a maintainer ----------
-
-# To maintain trust and collaboration with reviewers, first,
-# we will need to prove that you can contribute to the project well.
-# As you contribute more, the more responsibility you will have.
-
-# We will assign maintainers for specific languages as well.
-# As we notice more contribution from your side, we will let you know
-# and assign you a language.
\ No newline at end of file
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
deleted file mode 100644
index b03120fc..00000000
--- a/.github/FUNDING.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: technoph1le
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/ISSUE_TEMPLATE/bugs.yml b/.github/ISSUE_TEMPLATE/bugs.yml
deleted file mode 100644
index b5d03625..00000000
--- a/.github/ISSUE_TEMPLATE/bugs.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-name: "Bug Report"
-description: "File a bug report to fix issues in the codebase"
-title: "[Bug] - "
-labels: ["bug"]
-body:
- - type: markdown
- attributes:
- value: "# Bug report"
- - type: textarea
- id: description
- attributes:
- label: "What bug did you find in the codebase?"
- description: "Please explain the issue in as much detail as possible. Provide screenshots as necessary"
- validations:
- required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
deleted file mode 100644
index 3ba13e0c..00000000
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ /dev/null
@@ -1 +0,0 @@
-blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
deleted file mode 100644
index 1c4c2011..00000000
--- a/.github/ISSUE_TEMPLATE/docs.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-name: Documentation
-description: Request to update documentation or fix typos
-title: "[Docs] - "
-labels: ["documentation"]
-body:
- - type: markdown
- attributes:
- value: "# Update documentation"
- - type: textarea
- id: docs
- attributes:
- label: What changes would you like to make in the documentation?
- description: Please explain the issue and what the change should be
- validations:
- required: true
diff --git a/.github/ISSUE_TEMPLATE/features.yml b/.github/ISSUE_TEMPLATE/features.yml
deleted file mode 100644
index 3f77f087..00000000
--- a/.github/ISSUE_TEMPLATE/features.yml
+++ /dev/null
@@ -1,13 +0,0 @@
-name: Feature request
-description: Request for feature
-title: "[Feature] - "
-labels: ["feature"]
-body:
- - type: markdown
- attributes:
- value: "# Feature request"
- - type: textarea
- id: feature
- attributes:
- label: What feature would you like to see?
- description: Please provide a detailed description for the new feature.
diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml
deleted file mode 100644
index 6ecf7033..00000000
--- a/.github/ISSUE_TEMPLATE/general.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-name: General report
-description: This is a general issue that does not fit in the other categories
-title: "[General] - "
-body:
- - type: markdown
- attributes:
- value: "# General"
- - type: textarea
- id: description
- attributes:
- label: What general issue would you like to create?
- description: Please be as detailed as possible. Include code snippets or screenshots if necessary.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
deleted file mode 100644
index feb9e7be..00000000
--- a/.github/pull_request_template.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Description
-
-
-
-## Type of Change
-
-
-
-- [ ] ✨ New snippet
-- [ ] 🛠 Improvement to an existing snippet
-- [ ] 🐞 Bug fix
-- [ ] 📖 Documentation update
-- [ ] 🔧 Other (please describe):
-
-## Checklist
-
-
-
-- [ ] I have tested my code and verified it works as expected.
-- [ ] My code follows the style and contribution guidelines of this project.
-- [ ] Comments are added where necessary for clarity.
-- [ ] Documentation has been updated (if applicable).
-- [ ] There are no new warnings or errors from my changes.
-
-## Related Issues
-
-
-
-Closes #
-
-## Additional Context
-
-
-
-## Screenshots (Optional)
-
-
-
-
-Click to view screenshots
-
-
-
-
\ No newline at end of file
diff --git a/.github/workflows/check-snippets.yml b/.github/workflows/check-snippets.yml
deleted file mode 100644
index 5fb67bd7..00000000
--- a/.github/workflows/check-snippets.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-name: Checks snippets syntax
-
-on:
- pull_request:
- paths:
- - 'snippets/**'
-
-jobs:
- check-snippets:
- runs-on: ubuntu-latest
-
- steps:
- - name: Checkout repository
- uses: actions/checkout@v3
-
- - name: Set up Node.js
- uses: actions/setup-node@v3
- with:
- node-version: "16"
-
- - name: Check if snippets are formated correctly
- run: |
- node utils/checkSnippetFormatting.js # Run the script located in the utils/ folder
diff --git a/.github/workflows/consolidate-snippets.yml b/.github/workflows/consolidate-snippets.yml
deleted file mode 100644
index 507a51bd..00000000
--- a/.github/workflows/consolidate-snippets.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-name: Consolidate JSON Files
-
-on:
- push:
- paths:
- - "snippets/**"
-
-permissions:
- contents: write
-
-jobs:
- consolidate:
- runs-on: ubuntu-latest
-
- steps:
- - name: Checkout repository
- uses: actions/checkout@v3
-
- - name: Set up Node.js
- uses: actions/setup-node@v3
- with:
- node-version: "16"
-
- - name: Install dependencies
- run: |
- npm install
-
- - name: Consolidate Snippets
- run: |
- node utils/consolidateSnippets.js # Run the script located in the utils/ folder
-
- - name: Commit and push changes
- run: |
- git config --global user.name "GitHub Action"
- git config --global user.email "action@github.com"
- git add public/consolidated/*
- git commit -m "Update consolidated snippets"
- git push
diff --git a/.gitignore b/.gitignore
index b6cdf575..f25434ff 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,25 +1,43 @@
-# Logs
-logs
-*.log
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
-node_modules
-dist
-dist-ssr
-*.local
+# vercel
+.vercel
+
+# typescript
*.tsbuildinfo
+next-env.d.ts
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
+_pagefind/
\ No newline at end of file
diff --git a/.husky/pre-commit b/.husky/pre-commit
deleted file mode 100644
index 66ff6a67..00000000
--- a/.husky/pre-commit
+++ /dev/null
@@ -1,2 +0,0 @@
-npm run lint
-npm run build
diff --git a/.prettierignore b/.prettierignore
deleted file mode 100644
index 04fc37bb..00000000
--- a/.prettierignore
+++ /dev/null
@@ -1,6 +0,0 @@
-node_modules
-dist
-.vite
-coverage
-package-lock.json
-.md
\ No newline at end of file
diff --git a/.prettierrc b/.prettierrc
deleted file mode 100644
index 453861ee..00000000
--- a/.prettierrc
+++ /dev/null
@@ -1,12 +0,0 @@
-{
- "semi": true,
- "tabWidth": 2,
- "printWidth": 80,
- "singleQuote": false,
- "trailingComma": "es5",
- "bracketSpacing": true,
- "bracketSameLine": false,
- "arrowParens": "always",
- "endOfLine": "lf",
- "jsxSingleQuote": false
-}
diff --git a/.source/index.ts b/.source/index.ts
new file mode 100644
index 00000000..498a0bce
--- /dev/null
+++ b/.source/index.ts
@@ -0,0 +1,15 @@
+// @ts-nocheck -- skip type checking
+import * as docs_10 from "../content/docs/extensions/quicksnip.mdx?collection=docs&hash=1759902334815"
+import * as docs_9 from "../content/docs/extensions/quicksnip-vscode.mdx?collection=docs&hash=1759902334815"
+import * as docs_8 from "../content/docs/extensions/quicksnip-raycast.mdx?collection=docs&hash=1759902334815"
+import * as docs_7 from "../content/docs/extensions/quicksnip-cli.mdx?collection=docs&hash=1759902334815"
+import * as docs_6 from "../content/docs/contributing/third-party-apps.mdx?collection=docs&hash=1759902334815"
+import * as docs_5 from "../content/docs/contributing/modifying-snippets.mdx?collection=docs&hash=1759902334815"
+import * as docs_4 from "../content/docs/contributing/how-to-contribute.mdx?collection=docs&hash=1759902334815"
+import * as docs_3 from "../content/docs/contributing/adding-snippets.mdx?collection=docs&hash=1759902334815"
+import * as docs_2 from "../content/docs/installation.mdx?collection=docs&hash=1759902334815"
+import * as docs_1 from "../content/docs/index.mdx?collection=docs&hash=1759902334815"
+import * as docs_0 from "../content/docs/comparison.mdx?collection=docs&hash=1759902334815"
+import { _runtime } from "fumadocs-mdx/runtime/next"
+import * as _source from "../source.config"
+export const docs = _runtime.docs([{ info: {"path":"comparison.mdx","fullPath":"content\\docs\\comparison.mdx"}, data: docs_0 }, { info: {"path":"index.mdx","fullPath":"content\\docs\\index.mdx"}, data: docs_1 }, { info: {"path":"installation.mdx","fullPath":"content\\docs\\installation.mdx"}, data: docs_2 }, { info: {"path":"contributing/adding-snippets.mdx","fullPath":"content\\docs\\contributing\\adding-snippets.mdx"}, data: docs_3 }, { info: {"path":"contributing/how-to-contribute.mdx","fullPath":"content\\docs\\contributing\\how-to-contribute.mdx"}, data: docs_4 }, { info: {"path":"contributing/modifying-snippets.mdx","fullPath":"content\\docs\\contributing\\modifying-snippets.mdx"}, data: docs_5 }, { info: {"path":"contributing/third-party-apps.mdx","fullPath":"content\\docs\\contributing\\third-party-apps.mdx"}, data: docs_6 }, { info: {"path":"extensions/quicksnip-cli.mdx","fullPath":"content\\docs\\extensions\\quicksnip-cli.mdx"}, data: docs_7 }, { info: {"path":"extensions/quicksnip-raycast.mdx","fullPath":"content\\docs\\extensions\\quicksnip-raycast.mdx"}, data: docs_8 }, { info: {"path":"extensions/quicksnip-vscode.mdx","fullPath":"content\\docs\\extensions\\quicksnip-vscode.mdx"}, data: docs_9 }, { info: {"path":"extensions/quicksnip.mdx","fullPath":"content\\docs\\extensions\\quicksnip.mdx"}, data: docs_10 }], [{"info":{"path":"meta.json","fullPath":"content\\docs\\meta.json"},"data":{"title":"Docs","pages":["---Introduction---","index.mdx","installation.mdx","comparison.mdx","---Extensions---","...extensions","---Contributing---","...contributing"],"root":true}}, {"info":{"path":"extensions/meta.json","fullPath":"content\\docs\\extensions\\meta.json"},"data":{"title":"Extensions","pages":["quicksnip","quicksnip-cli","quicksnip-vscode","quicksnip-raycast"]}}, {"info":{"path":"contributing/meta.json","fullPath":"content\\docs\\contributing\\meta.json"},"data":{"title":"Contributing","pages":["how-to-contribute","adding-snippets","modifying-snippets","third-party-apps"]}}])
\ No newline at end of file
diff --git a/.source/source.config.mjs b/.source/source.config.mjs
new file mode 100644
index 00000000..30ec6e06
--- /dev/null
+++ b/.source/source.config.mjs
@@ -0,0 +1,24 @@
+// source.config.ts
+import {
+ defineConfig,
+ defineDocs,
+ frontmatterSchema,
+ metaSchema
+} from "fumadocs-mdx/config";
+var docs = defineDocs({
+ docs: {
+ schema: frontmatterSchema
+ },
+ meta: {
+ schema: metaSchema
+ }
+});
+var source_config_default = defineConfig({
+ mdxOptions: {
+ // MDX options
+ }
+});
+export {
+ source_config_default as default,
+ docs
+};
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 62adf023..2de3b640 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,7 @@
# Contributing to QuickSnip
+> THIS FILE NEEDS TO BE REWORKED. IT'S IMPORTED FROM PREVIOUS VERSION FOR TESTING.
+
Hey there! 👋 First off, thanks for taking the time to contribute! ❤️
You can contribute in two main ways:
@@ -11,10 +13,66 @@ You can contribute in two main ways:
## Improving the code
-If you have a feature request or want to fix a bug, feel free to:
+### How to report bugs
+
+If you spot a bug in the codebase or issues with the documentation, please open up a [GitHub issue](https://github.com/technoph1le/quicksnip/issues) detailing the problem before creating a PR. Once confirmed with maintainers, you can then create a PR.
+
+### How to propose new features
+
+If you are interested in proposing new features, please open up a new [GitHub discussion](https://github.com/technoph1le/quicksnip/discussions) with details for the proposed feature.
+
+Please do not create a PR for a new feature without first discussing it with the maintainers. If you create a PR for a new feature without discussing it first, then your PR will be closed.
+
+---
+
+## Snippets Guidelines
+
+### Snippet Tags
-- [Open an Issue](https://github.com/dostonnabotov/quicksnip/issues) to let us know what’s up.
-- [Send a Pull Request](https://github.com/dostonnabotov/quicksnip/pulls) with your changes.
+- Tags must describe the snippet with simple word.
+
+Here's an example:
+
+```md
+---
+title: Convert Number to Currency
+description: Converts a number to a currency format with a specific locale.
+author: axorax
+tags: number,currency
+---
+```
+
+**Do not use generic keywords or the language itself as a tag `utility` or `javascript`!**
+
+### Snippet Format
+
+**All** snippets should follow the following structure:
+
+- A `code` segment, containing a function with the actual snippet functionnality
+- An `example` segement, containing one or more examples of use
+
+Example in javascript:
+
+```js
+function example(x) {
+ return x * 2;
+}
+
+// Usage:
+example(5); // Returns: 10
+```
+
+If your function doesn't return anything just show how to use it. If the result of your function is too complicated to be expressed in a single comment, your snippet is probably too complex to begin with.
+
+### Snippet boundaries
+
+To ensure your snippet isn’t refused, consider these questions:
+
+- **Does the standard library of my language provide an easy way of doing this ?**
+- **Does that snippet not have a real, and practical use case ?**
+- **Could it be split into separate parts to be better understood ?**
+
+If any answer is yes, then your snippet will most likely get rejected.
---
@@ -22,26 +80,26 @@ If you have a feature request or want to fix a bug, feel free to:
### Adding a New Snippet
-To add a new code snippet:
+1. **Ensure your snippet match [guidelines](#snippets-guidelines)**
-1. **Navigate to the relevant folder:**
-
- - Go to the `/snippets` folder in the root directory.
- - Locate the folder for the programming language of your snippet, such as `javascript` or `python`.
+2. **Navigate to the relevant folder:**
-2. **Choose the correct category:**
+ - Go to the `/snippets` folder in the root directory.
+ - Locate the folder for the programming language of your snippet, such as `javascript` or `python`.
- - Within the language folder, find the relevant category folder for your snippet.
- - If no suitable category exists, refer to [Adding a New Category](#adding-a-new-category).
+3. **Choose the correct category:**
-3. **Create a markdown file:**
+ - Within the language folder, find the relevant category folder for your snippet.
+ - If no suitable category exists, refer to [Adding a New Category](#adding-a-new-category).
- - Create a new file with a `.md` extension.
- - Name the file appropriately, keeping it descriptive and concise.
+4. **Create a markdown file:**
-4. **Add your snippet:**
+ - Create a new file with a `.md` extension.
+ - Name the file appropriately, keeping it descriptive and concise.
- - Use the following format to structure your snippet:
+5. **Add your snippet:**
+
+ - Use the following format to structure your snippet:
````md
---
@@ -62,41 +120,62 @@ Here’s an example for JavaScript:
---
title: Format Date
description: Formats a date in 'YYYY-MM-DD' format.
-author: dostonnabotov
-tags: javascript,date,format
+author: technoph1le
+tags: date,format
---
```js
-const formatDate = (date) => date.toISOString().split('T')[0];
+const formatDate = (date) => date.toISOString().split("T")[0];
// Usage:
console.log(formatDate(new Date())); // Output: '2024-12-10'
```
````
-5. **Use syntax highlighting:**
- - Enclose your code with triple backticks (```).
- - Specify the language after the first set of backticks for syntax highlighting.
+6. **Use syntax highlighting:**
+
+ - Enclose your code with triple backticks (```).
+ - Specify the language after the first set of backticks for syntax highlighting.
+
+7. **Test your snippet:**
+
+ - Ensure your code runs as expected. \
+ To test that your snippets are formatted correctly use the `snippets:check` script:
+
+ ```
+ $ npm run snippets:check
+ ```
-6. **Test your snippet:**
- - Ensure your code runs as expected.
+ It will return nothing if they are well formatted, otherwise it will tell you what the error is.
+
+ ***
+
+ To preview the snippets, start the vite server using:
+
+ ```
+ $ npm run dev
+ ```
+
+ It will use HMR to update the snippets in the `/public` folder, making them available to the frontend.
Expected file structure:
```md
/snippets
- |- language
- |- category-name
- |- your-snippet-here.md
+|- language
+|- category-name
+|- your-snippet-here.md
```
+> Please do **NOT** add or edit anything in `/public` folder. It will be used for consolidating snippets.
+
### Editing a Existing Snippet
If you’d like to refine or improve an existing snippet:
1. **Add a `contributors` field:**
- - Include your GitHub username under the `contributors` field in the metadata section.
+ - Include your GitHub username under the `contributors` field in the metadata section.
````md
---
@@ -114,7 +193,7 @@ Updated code here
2. **Credit all contributors:**
- - If contributors already exist, add your username separated by a comma
+ - If contributors already exist, add your username separated by a comma
```md
contributors: contributor1, contributor2, your-github-username
@@ -122,10 +201,9 @@ contributors: contributor1, contributor2, your-github-username
3. **Document changes:**
-Clearly indicate what you updated and why in your pull request description.
-
-We want to make sure that original author and contributor(s) are credited for their work.
+ - Clearly indicate what you updated and why in your pull request description.
+> We want to make sure that original author and contributor(s) are credited for their work.
### Adding a New Category
@@ -133,22 +211,21 @@ If your snippet doesn’t fit into any existing category, you can create a new o
1. **Create a new category folder:**
- - In the relevant language directory, add a new folder.
- - Use a lowercase name with hyphens for separation (e.g., `file-handling`).
+ - In the relevant language directory, add a new folder.
+ - Use a lowercase name with hyphens for separation (e.g., `file-handling`).
2. **Add snippets:**
- - Follow the [Adding a New Snippet](#adding-a-new-snippet) instructions.
-
+ - Follow the [Adding a New Snippet](#adding-a-new-snippet) instructions.
Example structure:
```md
/snippets
- |- python
- |- file-handling
- |- list-manipulation
- |- ....
+|- python
+|- file-handling
+|- list-manipulation
+|- ....
```
### Adding a New Language
@@ -157,28 +234,48 @@ If you want to introduce a new programming language, here's how to do it:
1. **Create a language folder:**
- - Add a new folder under the `snippets` directory.
- - Name it after the language in lowercase (e.g., `go`, `ruby`).
+ - Add a new folder under the `snippets` directory.
+ - Name it after the language in lowercase (e.g., `go`, `ruby`).
2. **Add categories and snippets:**
- - Follow the [Adding a New Snippet](#adding-a-new-snippet) and [Adding a New Category](#adding-a-new-category) guidelines.
+ - Follow the [Adding a New Snippet](#adding-a-new-snippet) and [Adding a New Category](#adding-a-new-category) guidelines.
-4. **Include an icon:**
+3. **Include an icon:**
- - Add an `icon.svg` file (50x50px) in the same language folder.
- - Use tools like [Resize SVG](https://www.iloveimg.com/resize-image/resize-svg) to ensure the correct size.
+ - Add an `icon.svg` file (50x50px) in the same language folder.
+ - Use tools like [Resize SVG](https://www.iloveimg.com/resize-image/resize-svg) to ensure the correct size.
-5. **Double-check your work:**
+4. **Double-check your work:**
- - Verify that everything is structured correctly and displays as intended.
+ - Verify that everything is structured correctly and displays as intended.
---
+## Testing Snippets
+
+To test that your snippets are formatted correctly use the following script:
+
+```
+$ npm run snippets:check
+```
+
+It will return nothing if they are well formatted, otherwise it will tell you what the error is.
+
+---
+
+To preview the snippets, you need to consolidate them, use the following script:
+
+```
+$ npm run snippets:consolidate
+```
+
+It will update the snippets in the `/public` folder, making them available to the frontend.
+
## Final Notes
Whether you’re fixing a tiny typo, writing a new snippet, or dreaming up big features, every bit counts! 🛠️
-If you have any questions or need help, feel free to open an issue or tag me.
+If you have any questions or need help, feel free to open a new [GitHub discussion](https://github.com/technoph1le/quicksnip/discussions).
Happy coding! 💻✨
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index c25d9a45..00000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Technophile
-
-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.
diff --git a/README.md b/README.md
index 4826cfb3..128dca4d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# QuickSnip
-An open-source project that categorizes handy code snippets across various programming languages. Built with love and powered by an awesome community. 🚀
+QuickSnip is an open-source tool designed for developers who want to organize, search, and share code snippets across various programming languages. It provides a centralized platform for managing handy snippets. Built with love and powered by an awesome community. 🚀