cpp.js 1.0.0-beta.3 → 1.0.0-beta.5

package/README.md

@@ -0,0 +1,101 @@
+<div align="center">
+  <a href="https://cpp.js.org">
+    <picture>
+      <img alt="Next.js logo" src="https://cpp.js.org/img/logo.png" height="128">
+    </picture>
+  </a>
+  <h1>Cpp.js</h1>
+<p align="center">
+  <strong>Bind C++ to JavaScript with no extra code.</strong><br>
+  WebAssembly & React Native
+</p>
+
+<a href="https://www.npmjs.com/package/cpp.js"><img alt="NPM version" src="https://img.shields.io/npm/v/cpp.js?style=for-the-badge" /></a>
+<a href="https://github.com/bugra9/cpp.js/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/bugra9/cpp.js?style=for-the-badge" /></a>
+<a href=""><img alt="Discussions" src="https://img.shields.io/github/discussions/bugra9/cpp.js?style=for-the-badge" /></a>
+<a href=""><img alt="Discussions" src="https://img.shields.io/github/issues/bugra9/cpp.js?style=for-the-badge" /></a>
+</div>
+
+<h3 align="center">
+  <a href="https://cpp.js.org/docs/guide/getting-started/prerequisites">Getting Started</a>
+  <span> · </span>
+  <a href="https://cpp.js.org/docs/guide/integrate-into-existing-project/overview">Integrate Into Existing Project</a>
+  <span> · </span>
+  <a href="https://cpp.js.org/docs/api/cpp-bindings/overview">C++ Bindings</a>
+  <span> · </span>
+  <a href="https://cpp.js.org/showcase">Showcase</a>
+</h3>
+
+## Basic Usage
+**src/index.js**
+```js
+import { initCppJs } from './native/Factorial.h';
+
+const { Factorial } = await initCppJs();
+const factorial = new Factorial(99999);
+const result = factorial.calculate();
+console.log(result);
+```
+
+**src/native/Factorial.h**
+```c++
+class Factorial {
+private:
+    int number;
+
+public:
+    Factorial(int num) : number(num) {}
+
+    int calculate() {
+        if (number < 0) return -1;
+
+        int result = 1;
+        for (int i = 2; i <= number; i++) {
+            result *= i;
+        }
+        return result;
+    }
+};
+```
+
+## Prerequisites
+To begin building your project with Cpp.js, you’ll first need to install a few dependencies:
+
+- Docker
+- Node.js version 18 or higher
+- CMake version 3.28 or higher (only required for Mobile development)
+- Xcode (only required for iOS development)
+- Cocoapods (only required for iOS development)
+
+## Create a New Project
+To set up a new cpp.js project with a minimal starter structure, execute the following command in your terminal:
+```sh
+npm create cpp.js@latest
+```
+## Integrate Into Existing Project
+Integrate cpp.js seamlessly into your existing projects using the appropriate packages for your development needs. Refer to the documentation links for detailed integration guides.
+
+| Platform | Package(s) | Documentation |
+| -------- | ---------- | ------------- |
+| Standalone  | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/standalone) |
+| Webpack  | [cppjs-webpack-plugin](https://www.npmjs.com/package/cppjs-webpack-plugin), [cppjs-loader](https://www.npmjs.com/package/cppjs-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/webpack) |
+| Rollup  | [rollup-plugin-cppjs](https://www.npmjs.com/package/rollup-plugin-cppjs) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/rollup) |
+| Vite  | [vite-plugin-cppjs](https://www.npmjs.com/package/vite-plugin-cppjs) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/vite) |
+| Rspack  | [cppjs-webpack-plugin](https://www.npmjs.com/package/cppjs-webpack-plugin), [cppjs-loader](https://www.npmjs.com/package/cppjs-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/rspack) |
+| Create React App (CRA) | [cppjs-webpack-plugin](https://www.npmjs.com/package/cppjs-webpack-plugin), [cppjs-loader](https://www.npmjs.com/package/cppjs-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/create-react-app) |
+| React Native | [cppjs-plugin-react-native](https://www.npmjs.com/package/cppjs-plugin-react-native), [cppjs-plugin-react-native-ios-helper](https://www.npmjs.com/package/cppjs-plugin-react-native-ios-helper), [cppjs-core-rn-embind](https://www.npmjs.com/package/cppjs-core-rn-embind) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/react-native) |
+| Expo | [cppjs-plugin-react-native](https://www.npmjs.com/package/cppjs-plugin-react-native), [cppjs-plugin-react-native-ios-helper](https://www.npmjs.com/package/cppjs-plugin-react-native-ios-helper), [cppjs-core-rn-embind](https://www.npmjs.com/package/cppjs-core-rn-embind) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/expo) |
+| Node.js | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/nodejs) |
+| Cloudflare Workers  | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/cloudflare-worker) |
+
+## Features
+- [Calling C++ from JavaScript](https://cpp.js.org/docs/guide/features/calling-cpp-from-javascript)
+- [Packages](https://cpp.js.org/docs/guide/features/packages)
+- [Plugins](https://cpp.js.org/docs/guide/features/plugins)
+- [Assets](https://cpp.js.org/docs/guide/features/assets)
+- [Working with a Monorepo](https://cpp.js.org/docs/guide/features/monorepo)
+
+## License
+[MIT](https://github.com/bugra9/cpp.js/blob/main/LICENSE)
+
+Copyright (c) 2024, Buğra Sarı

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpp.js",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "license": "MIT",
   "type": "module",
   "homepage": "https://cpp.js.org",

package/src/bin.js

@@ -13,7 +13,7 @@ const packageJSON = JSON.parse(fs.readFileSync(new URL('../package.json', import
 const program = new Command();
 
 program
-    .name('cpp.js')
+    .name('cppjs')
     .description('Compile C++ files to WebAssembly and native platforms.')
     .version(packageJSON.version)
     .showHelpAfterError();