Merge pull request #3 from CintraAI/enhancement/updated-header

README.md

@@ -10,6 +10,7 @@ pinned: false
 license: mit
 ---
 
+
 # CintraAI Code Chunker
 
 Cintra's Code Chunker is a novel open-source tool designed to enhance code readability and maintainability by intelligently chunking code files based on key points of interest. This tool leverages advanced parsing techniques to identify significant elements in your code, such as functions, classes, and comments, to organize your codebase into manageable, easily understandable chunks. It's an invaluable resource for applications such as RAG, code patching, and other use cases.
@@ -19,6 +20,12 @@ Cintra's Code Chunker is a novel open-source tool designed to enhance code reada
 - **Intelligent Chunking:** Break down your code files into chunks around key points of interest like function definitions, class declarations, and crucial comments.
 - **Customizable Token Limits:** Control the size of each chunk with customizable token limits, ensuring that chunks remain manageable and focused.
 - **Support for Multiple Languages:** Initially supporting Python, JavaScript, and CSS, with plans to expand to more programming languages.
+
+## Try Out Code Chunker!
+
+Interested in seeing how it works? Check out our interactive demo on **Hugging Face Spaces**.
+
+[**Click here to try it out!**](https://huggingface.co/spaces/CintraAI/code-chunker)
   
 ## Getting Started
 
@@ -30,12 +37,12 @@ Cintra's Code Chunker is a novel open-source tool designed to enhance code reada
 
 1. Clone the repository:
 ```sh
-git clone https://github.com/yourgithubusername/code-chunker-parser.git
+git clone https://github.com/yourgithubusername/code-chunker.git
 ```
 
 2. Navigate to the project directory
 ```sh
-pip install -r requirements.txt
+cd code-chunker
 ```
 4. Install the required dependencies
 ```sh
@@ -64,7 +71,7 @@ points_of_interest = parser.extract_points_of_interest(tree, 'py')
 We welcome contributions from the community, whether it's through reporting bugs, submitting feature requests, or sending pull requests. Please check the CONTRIBUTING.md file for more details on how to contribute to the project.
 
 ## License
-This project is licensed under the Apache 2.0 license. See the License file for details
+This project is licensed under the MIT license. See the License file for details
 
 ## Acknowledgments
 - This project utilizes the tree-sitter project for parsing code.