bento-charts 1.0.0 → 1.0.2

package/README.md

@@ -1,9 +1,46 @@
+# Bento Charts
 
+[![Build Status](https://travis-ci.org/bento-platform/Bento-Charts.svg?branch=master)](https://travis-ci.org/bento-platform/Bento-Charts)
+[![Coverage Status](https://coveralls.io/repos/github/bento-platform/Bento-Charts/badge.svg?branch=master)](https://coveralls.io/github/bento-platform/Bento-Charts?branch=master)
+[![npm version](https://badge.fury.io/js/bento-charts.svg)](https://badge.fury.io/js/bento-charts)
 
-// TODO: Add comments telling how can you translate
-// TODO: Add a way for default translation
-// TODO: Add theme selection for chart
-// TODO: Add comment on how to remove missing
+Bento charts offers Bar and Pie charts for Bento project UI.
 
-There are two charts supported: Bar and Pie
-Refer 
+## Installation
+
+```bash
+npm install bento-charts
+```
+
+## Usage
+Wrap your app in the ChartConfigProvider and pass in the Language of your site.
+
+```jsx
+import { ChartConfigProvider } from 'bento-charts';
+```
+
+```jsx
+<ChartConfigProvider Lng={language}>
+  <App />
+</ChartConfigProvider>
+```
+Language can be either `'en'` or `'fr'`.
+
+You also can provide your own theme and translation dictionary.
+
+```jsx
+<ChartConfigProvider
+  Lng={language}
+  theme={theme}
+  translations={translations}
+>
+    <App />
+</ChartConfigProvider>
+```
+refer to [theme](https://github.com/bento-platform/Bento-Charts/blob/eee46541eec68e2dd7f62f8d786148480ce5105f/src/types/chartTypes.ts#L20) and [translations](https://github.com/bento-platform/Bento-Charts/blob/eee46541eec68e2dd7f62f8d786148480ce5105f/src/types/chartTypes.ts#L47) for more information.
+## Using a Chart
+
+```jsx
+import { BarChart, PieChart } from 'bento-charts';
+```
+Refer to [Props](https://github.com/bento-platform/Bento-Charts/blob/eee46541eec68e2dd7f62f8d786148480ce5105f/src/types/chartTypes.ts#L51) for information on their props.

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default as BarChart } from './Charts/BentoBarChart';
+export { default as PieChart } from './Charts/BentoPie';
+export { default as ChartConfigProvider } from './ChartConfigProvider';
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "bento-charts",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Charts library for Bento-platform",
-  "main": "./src/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "build": "webpack --mode=production",
-    "watch": "webpack --mode=development --watch"
+    "build": "npx tsc",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -31,8 +32,6 @@
   },
   "devDependencies": {
     "prettier": "2.7.1",
-    "typescript": "^4.9.5",
-    "webpack": "^5.76.0",
-    "webpack-cli": "^4.9.2"
+    "typescript": "^4.9.5"
   }
 }

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "outDir": "./dist/",
+    "outDir": "dist",
     "sourceMap": true,
     "strictNullChecks": true,
     "module": "es6",
@@ -9,16 +9,18 @@
     "skipLibCheck": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
-    "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "noEmit": false,
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+    "declaration": true,
   },
   "include": [
-    "./src/"
-  ]
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules"
+  ],
 }

package/.git-ignore

@@ -1,6 +0,0 @@
-build/*
-node_modules/*
-dist/*
-.DS_Store
-.idea/
-.vscode/

package/webpack.config.js

@@ -1,18 +0,0 @@
-module.exports = {
-  mode: 'production',
-  entry: './src/index.js',
-  output: {
-    filename: 'BentoCharts.js',
-    library: 'bento-charts',
-    libraryTarget: 'umd',
-    globalObject: 'this',
-  },
-  module: {
-    rules: [
-      { test: /\.[tj](sx|s)?$/, use: { loader: 'ts-loader' }, exclude: /node_modules/ }
-    ],
-  },
-  resolve: {
-    extensions: ['.tsx', '.ts', '.js'],
-  },
-};