Update README

Author: mrousavy

README.md

@@ -1,9 +1,21 @@
 <div align="center">
   <img src="img/icon.png" width="30%">
   <h1>react-native-multithreading</h2>
+  <h3>🧵 Fast and easy multithreading for React Native using JSI.</h3>
+  <br/>
+  <a align="center" href='https://ko-fi.com/F1F8CLXG' target='_blank'>
+    <img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
+  </a>
+  <br/>
+  <a align="center" href="https://github.com/mrousavy?tab=followers">
+    <img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
+  </a>
+  <br/>
+  <a align="center" href="https://twitter.com/mrousavy">
+    <img src="https://img.shields.io/twitter/follow/mrousavy?label=Follow%20%40mrousavy&style=social" />
+  </a>
 </div>
-
-Fast and easy multithreading for React Native using JSI.
+<br/>
 
 ## Installation
 
@@ -27,6 +39,7 @@ To simply do expensive calculation on another thread without caring about result
 ```ts
 // JS thread
 spawnThread(() => {
+  'worklet'
   // custom thread
   // expensive calculation
 })
@@ -41,8 +54,9 @@ Since `spawnThread` returns a `Promise`, you can also await the result. The Reac
 
 ```ts
 const result = await spawnThread(() => {
+  'worklet'
   // expensive calculation
-  return ...;
+  return ...
 })
 ```
 
@@ -52,12 +66,14 @@ This example calculates the [Fibonacci Number](https://en.wikipedia.org/wiki/Fib
 
 ```ts
 const fibonacci = (num: number): number => {
+  'worklet'
   if (num <= 1) return 1
   return fibonacci(num - 1) + fibonacci(num - 2)
 }
 
 const input = 50
 const result = await spawnThread(() => {
+  'worklet'
   console.log(`calculating fibonacci for input: ${input}...`)
   const fib = fibonacci(input)
   console.log("finished calculating fibonacci!")
@@ -66,6 +82,12 @@ const result = await spawnThread(() => {
 console.log(`Fibonacci Result: ${result}`)
 ```
 
+## Limitations
+
+1. At the moment, only iOS is implemented.
+2. Since the library uses JSI for synchronous native methods access, remote debugging (e.g. with Chrome) is no longer possible. Instead, you should use [Flipper](https://fbflipper.com).
+3. All functions you are calling inside a custom thread, must be workletized to truly run on a separate thread. So add the `'worklet'` directive at the top of every function you're calling in that thread (including the thread callback itself), and don't forget to install the Reanimated babel plugin.
+
 ## License
 
 MIT
@@ -74,5 +96,6 @@ MIT
 
 * [react-native-reanimated](http://github.com/software-mansion/react-native-reanimated) for Shared Value adapting, essentially allowing JSI multithreading
 * [Erik the Coder](https://www.erikthecoder.net/2019/03/30/async-does-not-imply-concurrent/) for the Icon
+* You, for appreciating my work
 
 > Note: Technically this is not [multithreading](https://en.wikipedia.org/wiki/Multithreading_(computer_architecture)), but rather [multiprocessing](https://en.wikipedia.org/wiki/Multiprocessing).

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-multithreading",
   "version": "0.1.0",
-  "description": "Fast and easy multithreading for React Native using JSI",
+  "description": "🧵 Fast and easy multithreading for React Native using JSI",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
   "types": "lib/typescript/src/index.d.ts",