nanoplot 0.0.27 → 0.0.29

package/CONTRIBUTIONS.md

@@ -1,24 +1,7 @@
-### Get started
-Step 1: Fork the Repository
-
-Click the Fork Button: In the upper right corner of the repository page, click on the Fork button. This will create a copy of the repository under your GitHub account.
-Step 2: Clone your Forked Repository
-
-Go to Your Forked Repository:
-Navigate to your GitHub profile and find the newly forked repository.
-Copy the Clone URL:
-Click on the green Code button.
-Choose either HTTPS, SSH, or GitHub CLI based on your preference and copy the URL.
-Open Your Terminal: Open a terminal or command prompt on your local machine.
-Run the Clone Command: Use the git clone https//xxxx.git command to clone your forked repository:
-
-Step 3:
-Navigate into Your Cloned Repository and install bun packages cd nanoplot
-
 ```bash
 bun i
+bun run build:library
 bun run dev
 ```
-The application should run locally on your machine on port: 3000
-
-Step 4: Start Implementing
+build:library, dogfoods the library so our examples are always reflective of a real library installation.
+i.e website examples actually import from "nanoplot" (the package).

package/README.md

@@ -7,10 +7,11 @@
 
 
 ## Design Philosophy
-- Smallest possible bundle size (10KB per graph on AVG)
+- Smallest possible bundle size (10KB per graph on AVG) and zero dependencies.
 - React First, React Only, RSC First.
 - Fully responsive without javascript
 
+
 ## Getting Started
 ```shell
 npm install nanoplot
@@ -24,8 +25,8 @@ The world's smallest companies use our software to plot their data.
 ## Usage
 ```javascript
 import "nanoplot/styles.css";
-import { Graph } from "";
-import { Pie } from "";
+import { Graph } from "nanoplot/Graph";
+import { Pie } from "nanoplot/Pie";
 
 <Graph data={[{name: "Male", value: 50}, {name: "Female", value: 50}]}>
     <Pie />