Update README.md

MYC-Refactor
Hammy 3 years ago
parent 26314c4455
commit d6b1ae5da9

@ -1,7 +1,8 @@
[license]: https://img.shields.io/github/license/sgoudham/MyClipboard [license]: https://img.shields.io/github/license/sgoudham/MyClipboard
[maven-central]: https://img.shields.io/maven-central/v/me.goudham/MyClipboard.svg?label=Maven%20Central [maven-central]: https://img.shields.io/maven-central/v/me.goudham/MyClipboard.svg?label=Maven%20Central
[build-status]: https://goudham.me/jenkins/job/MyClipboard/job/release/badge/icon [build-status]: https://goudham.me/jenkins/job/MyClipboard/job/release/badge/icon
[codecov]:
[comment]: <> ([codecov]: )
[issues]: https://img.shields.io/github/issues/sgoudham/MyClipboard?label=issues [issues]: https://img.shields.io/github/issues/sgoudham/MyClipboard?label=issues
[pull-requests]: https://img.shields.io/github/issues-pr/sgoudham/MyClipboard [pull-requests]: https://img.shields.io/github/issues-pr/sgoudham/MyClipboard
[fossa]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard.svg?type=shield [fossa]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard.svg?type=shield
@ -10,7 +11,6 @@
![license] ![license]
![maven-central] ![maven-central]
![build-status] ![build-status]
![codecov]
![issues] ![issues]
![pull-requests] ![pull-requests]
@ -18,14 +18,25 @@
Utility Library to Access and Manipulate the Default System Clipboard Utility Library to Access and Manipulate the Default System Clipboard
# About # About
The inspiration for this project came from my frustration of macOS not having clipboard history
built-in unlike Windows. This library will allow you to access the system clipboard and manipulate it.
# Configuration # Configuration
TODO
# Windows / *Unix # Windows / *Unix
This approach differs from the macOS section below as Windows/*Unix properly notify the program with global clipboard events.
This allows for a more event-driven approach as lostOwnership() is triggered whenever the clipboard has lost ownership - clipboard
has new content within it - and the contents can be observed by multiple consumers.
# macOS
Unlike the aforementioned event-driven approach, macOS unfortunately is not very good at notifying the program if the
system clipboard has changed. To query the system clipboard contents, we need to employ a polling schedule. I have chosen
**350ms** to ensure that images and large files can be copied over as well as reducing the load on the CPU.
# Mac OSX
# Contributing # Contributing
TODO
# License # License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard?ref=badge_large) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsgoudham%2FMyClipboard?ref=badge_large)
Loading…
Cancel
Save