Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RamK777-stack committed Sep 29, 2024
1 parent 752f906 commit 4e6ae01
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 50 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2024] [RavanMind]

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.
81 changes: 31 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,31 @@
# React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
```

- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:

```js
// eslint.config.js
import react from 'eslint-plugin-react'

export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
```
# JIRA Bot Chrome Extension

**JIRA Bot Chrome Extension** is your go-to tool for managing JIRA tickets right from your browser. With real-time updates, AI-powered insights, and seamless integration into your workflow, it helps you stay productive without the need to switch between tabs.

## Features

### 📢 **Instant JIRA Updates**
Get notified in real-time about changes in tickets, sprint progress, and team summaries. Stay on top of your work without leaving your current tab.

### 🧠 **AI-Powered Insights**
Leverage advanced AI to get smart summaries, predictions, and actionable suggestions based on your JIRA data. Make faster, data-driven decisions with less effort.

### 🔄 **Seamless Integration**
Our extension fits effortlessly into your workflow, allowing you to access, update, and manage JIRA tickets directly from Chrome. Chat with your tickets and get AI-powered summaries in a single, unified view.

### 🚀 **Boost Productivity**
Save time by managing your JIRA tasks in one place. No more jumping between apps – stay focused and get more done.

## Usage

1. Log in to your Atlassian account via the extension.
2. Add your JIRA API keys to access and manage your tickets.
3. Start chatting with your JIRA tickets directly from the extension. Use simple commands to get updates, summaries, and AI-powered insights.

## Contributing

We welcome contributions! If you’d like to report an issue or submit a pull request, feel free to check out our [Contributing Guide](CONTRIBUTING.md).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 4e6ae01

Please sign in to comment.