diff --git a/README.md b/README.md index e98041d..7567833 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Quillbot -Quillbot is a AI article rewriter/spinner. This script uses Chrome Headless Browser and rephrases (plagiarise). -They no longer have an API so this is the slow scraping method using Puppeteer. -This was a learning project for myself. +Quillbot is an AI article rewriter/spinner. This script uses Chrome Headless Browser to interact with [Quillbot](https://quillbot.com/) to rephrase (plagiarise) text. +Quillbot no longer has an API, so this is the slow scraping method using Puppeteer. + +Note that this is a learning project for myself and I'm a hobbyist programmer. # Install @@ -10,6 +11,19 @@ git clone npm install -# run +# run example + +node test + + +# example code + +``` + const paragraph = 'TCP is a connection-oriented protocol, which means that the end-to-end communications is set up using handshaking. Once the connection is set up, user data may be sent bi-directionally over the connection. Compared to TCP, UDP is a simpler message based connectionless protocol, which means that the end-to-end connection is not dedicated and information is transmitted in one direction from the source to its destination without verifying the readiness or state of the receiver. TCP controls message acknowledgment, retransmission and timeout. TCP makes multiple attempts to deliver messages that get lost along the way, In TCP therefore, there is no missing data, and if ever there are multiple timeouts, the connection is dropped. When a UDP message is sent there is no guarantee that the message it will reach its destination; it could get lost along the way.'; + const paraphrased = await quillbot(paragraph); -node index + console.log('Before:'); + console.log(paragraph); + console.log('Paraphrased:'); + console.log(paraphrased); +```