diff --git a/cli/package.json b/cli/package.json index c3ae520..513c245 100644 --- a/cli/package.json +++ b/cli/package.json @@ -1,6 +1,6 @@ { "name": "@entityseven/create-rage-fw", - "version": "0.1.0", + "version": "0.1.1", "bin": { "rage-fw": "dist/index.js" }, diff --git a/cli/readme.md b/cli/readme.md index f8c9983..cff24d6 100644 --- a/cli/readme.md +++ b/cli/readme.md @@ -2,7 +2,7 @@ To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/) -``pnpm create rage-fw@latest`` +``pnpm create @entityseven/rage-fw@latest`` ## TL;DR - ``Initialize new project`` - create new template project diff --git a/package.json b/package.json index 92afeec..34ba0de 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "private": true, "scripts": { - "publish": "pnpm build && lerna publish --force-publish", + "publish": "lerna publish --force-publish", "build": "lerna run build", "lint": "eslint --c .eslintrc.yaml --ext .ts client/ server/ shared-types/", diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index a24848b..d71b804 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,7 +1,2 @@ packages: - - "server" - - "client" - - "cef" - - "rpc" - - "cli" - - "shared-types" \ No newline at end of file + - "rpc" \ No newline at end of file diff --git a/rpc/package.json b/rpc/package.json index c143cc3..5850e57 100644 --- a/rpc/package.json +++ b/rpc/package.json @@ -1,5 +1,5 @@ { - "name": "rage-fw-rpc", + "name": "@entityseven/rage-fw-rpc", "description": "Rage FW RPC", "version": "0.2.5", "scripts": { diff --git a/rpc/readme.md b/rpc/readme.md index 10f2e40..d6960be 100644 --- a/rpc/readme.md +++ b/rpc/readme.md @@ -14,12 +14,17 @@ yarn add rage-fw-rpc Import installed package and initialize rpc: ```ts - // lib/rpc.js +// lib/rpc.js - import { Rpc } from 'rage-fw-rpc' - export const rpc = new Rpc(/* options */) +import { Rpc } from 'rage-fw-rpc' +export const rpc = new Rpc(/* options */) ``` +# Motivation +The idea was to create an extensible package, with various features to simplify the development process and provide as much comfort as possible. It should also be using similar architecture as the framework it was specially built for + +Inspired by usage of [rage-rpc](https://github.com/micaww/rage-rpc) + # Features - Type-safe events via [TS generics](https://www.typescriptlang.org/docs/handbook/2/generics.html), avoiding type wrappers - Built-in logging options for each environment @@ -28,7 +33,7 @@ Import installed package and initialize rpc: - Actual human-readable errors # Docs -*Extended version with details coming soon* +## [Extended version available here](https://git.entityseven.com/entityseven/rage-framework/wiki/RPC%400.2.5) ## register Registers a callback function for a specified event