react-char-fill 1.0.1 → 1.0.3

package/README.md

@@ -1,20 +1,20 @@
 # React Char Fill
 
-A versatile React component library for creating flexible character-based ratings, perfect for star ratings and other similar use cases.
+A versatile React component library for creating customizable character-based ratings. Ideal for star ratings and other similar applications, with fine-grained control over rating steps, colors, and interactivity.
 
 ## Installation
 
-To install the package, use npm, yarn, or bun:
+Install the package using your preferred package manager:
 
-npm install react-char-fill
+`npm install react-char-fill`
 
 or
 
-yarn add react-char-fill
+`yarn add react-char-fill`
 
 or
 
-bun add react-char-fill
+`bun add react-char-fill`
 
 ## Usage
 
@@ -22,11 +22,12 @@ bun add react-char-fill
 
 Here is a basic example of how to use the `CharacterRating` component:
 
+```jsx
 import CharacterRating from 'react-char-fill';
 
 const App = () => {
-return (
-<CharacterRating
+  return (
+    <CharacterRating
       rating={3.5}
       character="★"
       maxRating={5}
@@ -35,20 +36,22 @@ return (
       interactive={false}
       step={0.5}
     />
-);
+  );
 };
 
 export default App;
+```
 
 ### Advanced Example
 
-You can also customize the colors, font size, and other props:
+You can also customize various aspects of the rating, such as colors, font size, and interactivity:
 
+```jsx
 import CharacterRating from 'react-char-fill';
 
 const App = () => {
-return (
-<CharacterRating
+  return (
+    <CharacterRating
       rating={4.2}
       character="☆"
       maxRating={10}
@@ -58,16 +61,17 @@ return (
       interactive={true}
       step={0.1}
     />
-);
+  );
 };
 
 export default App;
+```
 
 ## API Documentation
 
 ### `CharacterRating`
 
-A component to display a rating using characters.
+This component displays a rating using characters and provides the ability to customize and interact with the rating.
 
 #### Props
 
@@ -83,20 +87,6 @@ A component to display a rating using characters.
 - `onClick` (function, optional): Function to call on click.
 - `onKeyDown` (function, optional): Function to call on key down.
 
-### `CharacterFill`
-
-A component used internally by `CharacterRating` to render individual characters.
-
-#### Props
-
-- `position` (number, required): The position of the character in the rating sequence.
-- `rating` (number, required): The current rating value.
-- `character` (string, required): The character used to represent the rating.
-- `emptyColor` (string, optional): The color for the empty rating characters. Default is `grey`.
-- `fillColor` (string, optional): The color for the filled rating characters. Default is `gold`.
-- `fontSize` (string, optional): The size of the character. Default is `24px`.
-- `step` (number, required): The increment step for the rating value.
-
 ## Contributing
 
 Contributions are welcome! Please follow these steps to contribute:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-char-fill",
   "description": "A React component for creating flexible character-based ratings, perfect for star ratings and other similar use cases.",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "dist/react-char-fill.umd.js",
   "module": "dist/react-char-fill.es.js",
   "types": "dist/index.d.ts",