Skip to content

Commit

Permalink
Update readme (#8)
Browse files Browse the repository at this point in the history
* update readme

* add badge
  • Loading branch information
alDuncanson authored May 24, 2023
1 parent 12d06d3 commit cd4e7c7
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
Manage your clipboard history with Copycat!
<br />
<br />
<a href="https://github.com/alDuncanson/cuppa/issues">Report a Bug</a>
<a href="https://github.com/alDuncanson/Copycat/issues/new?assignees=alDuncanson&labels=bug&projects=&template=bug_report.md&title=">Report a Bug</a>
·
<a href="https://github.com/alDuncanson/cuppa/issues">Request Feature</a>
<a href="https://github.com/alDuncanson/Copycat/issues/new?assignees=alDuncanson&labels=enhancement&projects=&template=feature_request.md&title=">Request Feature</a>
</p>
</div>

Expand All @@ -30,6 +30,11 @@
<img src="https://img.shields.io/github/sponsors/alDuncanson">
</a>
</div>
<div align="center">
<a href="https://chrome.google.com/webstore/detail/copycat/gdfhhdijmhnmgpjpifkdnmajomaaceng">
<img src="https://img.shields.io/chrome-web-store/v/gdfhhdijmhnmgpjpifkdnmajomaaceng">
</a>
</div>

## About

Expand All @@ -49,13 +54,13 @@ Copycat saves your clipboard history so you can paste it later!
</ol>
</details>

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## Installation

Pending review in the Chrome Web Store.
Install Copycat from the [Chrome Web Store](https://chrome.google.com/webstore/detail/copycat/gdfhhdijmhnmgpjpifkdnmajomaaceng)

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## Usage

Expand All @@ -71,49 +76,52 @@ Pending review in the Chrome Web Store.

<img src="content/copy_and_delete.gif" width="400" alt="Copy again or delete a copy" />

<p align="right">(<a href="#top">back to top</a>)</p>
### Copy images

Right-click an image and select "Copycat image" to save it to your clipboard history.

<img src="content/context_menu.png" width="400" alt="Copy again or delete a copy" />

<p align="right"><a href="#top">back to top</a></p>

## Roadmap

- [x] Copy images
- [ ] Display copied hex codes as colors
- [ ] Clickable links
- [ ] Stylized code snippets
- [ ] Stylized quotes
- [ ] Sync clipboard history across devices

See requested features and ideas in [Copycat Discussions](https://github.com/alDuncanson/Copycat/discussions/categories/ideas)!

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## Contributing

If you have a suggestion that would make Copycat better, you can open an issue with the tag `enhancement`.
If you have a suggestion that would make Copycat better, you can request a feature [here](https://github.com/alDuncanson/Copycat/issues/new?assignees=alDuncanson&labels=enhancement&projects=&template=feature_request.md&title=).

Or feel free to fork the project and open a pull request with your suggested changes.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/RadFeature`)
3. Commit your Changes (`git commit -m 'Add some RadFeature'`)
4. Push to the Branch (`git push origin feature/RadFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## License

Distributed under the MIT License. See [LICENSE](https://github.com/alDuncanson/Copycat/blob/main/LICENSE) for more information.

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## Contact

[email protected]

<a href='https://www.buymeacoffee.com/alduncanson' target='_blank'><img src='https://cdn.buymeacoffee.com/buttons/default-orange.png' alt='Buy Me A Coffee' height='34' width='144'></a>

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>

## Acknowledgments

- [Project badges](https://shields.io)
- [Shields.io](https://shields.io)
- [TailwindUI](https://tailwindui.com/)

<p align="right">(<a href="#top">back to top</a>)</p>
<p align="right"><a href="#top">back to top</a></p>
Binary file added content/context_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd4e7c7

Please sign in to comment.