doc update

charmy · Apr 14, 2024 · 4dd6e6c · 4dd6e6c
1 parent db2ee1f
commit 4dd6e6c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 Allows you to add stylish text with stroke effects to your mobile applications. It is perfect for creating visually appealing text elements with outline effects.
 
 <h1 align="center">
-  <img width="450" src="docs/example.jpeg"/>
+  <img width="550" src="docs/example.jpeg"/>
 </h1>
 
 
@@ -65,6 +65,29 @@ The following table outlines the props available for the `StrokeText` component:
 | `width`         | number | Text width to enable ellipsis (default: `undefined`)            |
 
 
+## Ellipsis
+
+```jsx
+<StrokeText
+    text="Lorem ipsum"
+        width={150} // +
+        ellipsis={true} // +
+        numberOfLines={1} // +
+    fontSize={32}
+    color="#FFFFFF"
+    strokeColor="#000000"
+    strokeWidth={2}
+    fontFamily="Nunito-Black"
+    align="center"
+/>
+
+```
+
+<h1 align="center">
+  <img width="450" src="docs/ellipsis.jpeg"/>
+</h1>
+
+
 ## Custom Font
 Create a `react-native.config.js` file in the root directory
 

diff --git a/docs/ellipsis.jpeg b/docs/ellipsis.jpeg
diff --git a/docs/example.jpeg b/docs/example.jpeg