Skip to content

Commit 85e7799

Browse files
committed
Rename org to nucleoidai
1 parent d84aa86 commit 85e7799

File tree

11 files changed

+37
-39
lines changed

11 files changed

+37
-39
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<a href="https://www.apache.org/licenses/LICENSE-2.0">
55
<img src="https://img.shields.io/badge/Apache-2.0-yellow?style=for-the-badge&logo=apache" alt="License" />
66
</a>
7-
<a href="https://www.npmjs.com/package/@nucleoidjs/synapses">
7+
<a href="https://www.npmjs.com/package/@nucleoidai/react-event">
88
<img src="https://img.shields.io/badge/NPM-red?style=for-the-badge&logo=npm" alt="NPM" />
99
</a>
1010
<a href="https://discord.com/invite/eWXFCCuU5y">

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 3
99
Creates application
1010

1111
```javascript
12-
const nucleoid = require("nucleoidjs");
12+
const nucleoid = require("nucleoidai");
1313
const app = nucleoid();
1414
```
1515

docs/contributing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Learn more at [nucleoid.com/docs/runtime](/docs/runtime/)
1414

1515
## Code of Conduct
1616

17-
Please read our [Code of Conduct](https://github.com/NucleoidJS/Nucleoid/blob/main/CODE_OF_CONDUCT.md)
17+
Please read our [Code of Conduct](https://github.com/NucleoidAI/Nucleoid/blob/main/CODE_OF_CONDUCT.md)
1818

19-
## Join our [Thinkers Club](https://github.com/NucleoidJS/Nucleoid/discussions/categories/thinkers-club)
19+
## Join our [Thinkers Club](https://github.com/NucleoidAI/Nucleoid/discussions/categories/thinkers-club)
2020

21-
If you have an opinion, you are already a philosopher. We are working on brand-new approach to data and logic. Come join us in [discussions](https://github.com/NucleoidJS/Nucleoid/discussions/categories/thinkers-club).
21+
If you have an opinion, you are already a philosopher. We are working on brand-new approach to data and logic. Come join us in [discussions](https://github.com/NucleoidAI/Nucleoid/discussions/categories/thinkers-club).
2222

23-
[![Nobel](https://cdn.nucleoid.com/media/nobel.png)](https://github.com/NucleoidJS/Nucleoid/discussions/categories/thinkers-club)
23+
[![Nobel](https://cdn.nucleoid.com/media/nobel.png)](https://github.com/NucleoidAI/Nucleoid/discussions/categories/thinkers-club)
2424

2525
### Pinned Discussions
2626

27-
[![Discussion 25](https://cdn.nucleoid.com/media/discussion-25x500.png)](https://github.com/NucleoidJS/Nucleoid/discussions/25)
28-
[![Discussion 26](https://cdn.nucleoid.com/media/discussion-26x500.png)](https://github.com/NucleoidJS/Nucleoid/discussions/26)
29-
[![Discussion 28](https://cdn.nucleoid.com/media/discussion-28x500.png)](https://github.com/NucleoidJS/Nucleoid/discussions/28)
27+
[![Discussion 25](https://cdn.nucleoid.com/media/discussion-25x500.png)](https://github.com/NucleoidAI/Nucleoid/discussions/25)
28+
[![Discussion 26](https://cdn.nucleoid.com/media/discussion-26x500.png)](https://github.com/NucleoidAI/Nucleoid/discussions/26)
29+
[![Discussion 28](https://cdn.nucleoid.com/media/discussion-28x500.png)](https://github.com/NucleoidAI/Nucleoid/discussions/28)

docs/datastore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Nucleoid is not designed for specific scalability model, in fact high plasticity
8686
The smart sharding takes a JavaScript function and lets developers create own scalability policies unlike limited configuration options in major databases. The function receives additional data such as request headers, body etc. and it also comes with Nucleoid runtime along with the built-in data store, so that the sharding function can persist user data in order to support `memtable` like in Cassandra.
8787

8888
```shell
89-
npx nucleoidjs start --cluster
89+
npx nucleoidai start --cluster
9090
```
9191

9292
This `npx` command starts specialized Nucleoid instance and acts like a front door to the cluster. The default sharding function takes `Process` header from REST and looks up in process list for IP and port information, and cluster instances can be added with calling terminal with `process1 = new Process("127.0.0.1", 8448)`.
@@ -118,7 +118,7 @@ https://nucleoid.com/ide/sample
118118

119119
> Performance benchmark is run in t2.micro of AWS EC2 instance and both databases had dedicated servers with no indexes and default configurations.
120120
121-
https://github.com/NucleoidJS/benchmark
121+
https://github.com/NucleoidAI/benchmark
122122

123123
This does not necessary mean Nucleoid runtime is faster than MySQL or Postgres, instead many DBs in production require constant maintenance by DBA team with adjusting indexing, caching, purging etc. but Nucleoid tries to solve this problem with managing logic and data internally.
124124

docs/get-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 1
44

55
# Get Started
66

7-
[![npm](https://img.shields.io/npm/v/nucleoidjs)](https://www.npmjs.com/package/nucleoidjs) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nucleoidjs/nucleoid/test.yml?branch=main)](https://github.com/NucleoidJS/Nucleoid/actions/workflows/test.yml)
7+
[![npm](https://img.shields.io/npm/v/nucleoidai)](https://www.npmjs.com/package/nucleoidai) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nucleoidai/nucleoid/test.yml?branch=main)](https://github.com/NucleoidAI/Nucleoid/actions/workflows/test.yml)
88

99
Nucleoid serves as a reasoning engine for neuro-symbolic AI, implementing symbolic AI through declarative (logic-based) programming. Integrated within the Node.js runtime, it observes and manages statements in JavaScript, establishing intricate relationships among variables, objects, and functions in a graph structure. Installation is straightforward via npm, with no need for an external database, enhancing its accessibility and efficiency for neuro-symbolic applications.
1010

@@ -21,7 +21,7 @@ Nucleoid serves as a reasoning engine for neuro-symbolic AI, implementing symbol
2121
Once included in the project, you can initialize as:
2222

2323
```javascript
24-
const nucleoid = require("nucleoidjs");
24+
const nucleoid = require("nucleoidai");
2525
const app = nucleoid();
2626
```
2727

docs/learn.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import ReactPlayer from "react-player";
66

77
# Learn
88

9-
[![NPM](https://img.shields.io/npm/l/nucleoidjs)](https://www.apache.org/licenses/LICENSE-2.0) [![npm](https://img.shields.io/npm/v/nucleoidjs)](https://www.npmjs.com/package/nucleoidjs)
9+
[![NPM](https://img.shields.io/npm/l/nucleoidai)](https://www.apache.org/licenses/LICENSE-2.0) [![npm](https://img.shields.io/npm/v/nucleoidai)](https://www.npmjs.com/package/nucleoidai)
1010

1111
## Introduction
1212

@@ -138,20 +138,20 @@ human1.mortal;
138138
Nucleoid runtime runs top of Node.js, it can be installed as a npm package:
139139

140140
```shell
141-
> npm i nucleoidjs
141+
> npm i nucleoidai
142142
```
143143

144144
Initialize the runtime with this:
145145

146146
```javascript
147-
const nucleoid = require("nucleoidjs");
147+
const nucleoid = require("nucleoidai");
148148
const app = nucleoid();
149149
```
150150

151151
> :bulb: The runtime uses local files for internal data management, and stores every statement locally. This clears local data:
152152
>
153153
> ```shell
154-
> > npx nucleoidjs clear
154+
> > npx nucleoidai clear
155155
> ```
156156
157157
## Variables

docs/synapses.md renamed to docs/react-event.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
---
22
sidebar_position: 9
3-
title: Synapses
3+
title: react-event
44
---
55

6-
# Synapses
7-
8-
<h1 align="center">Synapses</h1>
6+
<h1 align="center">react-event</h1>
97

108
<p align="center">
119
<a href="https://www.apache.org/licenses/LICENSE-2.0">
1210
<img src="https://img.shields.io/badge/Apache-2.0-yellow?style=for-the-badge&logo=apache" alt="License" />
1311
</a>
14-
<a href="https://www.npmjs.com/package/@nucleoidjs/synapses">
12+
<a href="https://www.npmjs.com/package/@nucleoidai/react-event">
1513
<img src="https://img.shields.io/badge/NPM-red?style=for-the-badge&logo=npm" alt="NPM" />
1614
</a>
1715
<a href="https://discord.com/invite/eWXFCCuU5y">
@@ -28,19 +26,19 @@ title: Synapses
2826
<br/>
2927

3028
```shell
31-
npm i @nucleoidjs/synapses
29+
npm i @nucleoidai/react-event
3230
```
3331

34-
Synapses is an alternative to React Context with event-driven style communication that helps to build loosely coupled components.
32+
`react-event` is an alternative to React Context with event-driven style communication that helps to build loosely coupled components.
3533

3634
### How it works?
3735

38-
Subscribers are registered an event with the custom hook `useEvent(eventType, initialValue)`, once publisher posts an event and its payload, Synapses asynchronously sends the event to subscribed components and subscribed components will eventually be re-rendered with fresh data.
36+
Subscribers are registered an event with the custom hook `useEvent(eventType, initialValue)`, once publisher posts an event and its payload, `react-event` asynchronously sends the event to subscribed components and subscribed components will eventually be re-rendered with fresh data.
3937

4038
Example:
4139

4240
```javascript
43-
import { publish } from "@nucleoidjs/synapses";
41+
import { publish } from "@nucleoidai/react-event";
4442

4543
const PublishComponent = () => {
4644
return (
@@ -56,7 +54,7 @@ const PublishComponent = () => {
5654
```
5755

5856
```javascript
59-
import { useEvent } from "@nucleoidjs/synapses";
57+
import { useEvent } from "@nucleoidai/react-event";
6058

6159
const Component1 = () => {
6260
const [event] = useEvent("BUTTON_CLICKED", { number: 10 });
@@ -66,7 +64,7 @@ const Component1 = () => {
6664
```
6765

6866
```javascript
69-
import { useEvent } from "@nucleoidjs/synapses";
67+
import { useEvent } from "@nucleoidai/react-event";
7068

7169
const Component2 = () => {
7270
const [event] = useEvent("BUTTON_CLICKED", { string: "blue" });
@@ -75,13 +73,13 @@ const Component2 = () => {
7573
};
7674
```
7775

78-
<img src="https://cdn.nucleoid.com/media/synapses-sample.gif" alt="Sample Synapses" width="350" />
76+
<img src="https://cdn.nucleoid.com/media/synapses-sample.gif" alt="Sample react-event" width="350" />
7977

8078
The complete sample project is [here](./sample).
8179

8280
### Stateless Handling
8381

84-
Synapses supports stateless components with caching last published payload for the event type, so that if the component is re-rendered, it won't lose the payload. For example, Component 3 in this example is not re-rendered yet, but Synapses holds the last payload for the event type, and once the component is rendered, it returns the payload instead of initial value.
82+
`react-event` supports stateless components with caching last published payload for the event type, so that if the component is re-rendered, it won't lose the payload. For example, Component 3 in this example is not re-rendered yet, but Synapses holds the last payload for the event type, and once the component is rendered, it returns the payload instead of initial value.
8583

8684
<img src="https://cdn.nucleoid.com/media/synapses.drawio.png" alt="Synapses Diagram" width="350" />
8785

docs/runtime/mechanics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Important objectives of Nucleoid runtime manages the control flow with graph and
3232
## Example
3333

3434
```javascript
35-
const nucleoid = require("nucleoidjs");
35+
const nucleoid = require("nucleoidai");
3636

3737
nucleoid.run(() => {
3838
var a = 1;
@@ -51,7 +51,7 @@ Here is the logical diagram of the runtime, and let's dive into to details
5151

5252
![Mechanics](../../static/media/mechanics.drawio.png)
5353

54-
1. When Node.js passes over the function, very first step is the function string is parsed into [`$nuc`](https://github.com/NucleoidJS/Nucleoid/tree/main/src/lang/%24nuc) structure as [CIL](https://en.wikipedia.org/wiki/Common_Intermediate_Language) language, which holds input statements as executable.
54+
1. When Node.js passes over the function, very first step is the function string is parsed into [`$nuc`](https://github.com/NucleoidAI/Nucleoid/tree/main/src/lang/%24nuc) structure as [CIL](https://en.wikipedia.org/wiki/Common_Intermediate_Language) language, which holds input statements as executable.
5555

5656
> Something keep in mind, every programming language actually works with string and compiles to executable binaries or bytes, one thing is slightly different in the Nucleoid project, all CIL conversion happens at runtime instead of compile time. This gives advantages when manipulating [Control Flow](https://en.wikipedia.org/wiki/Control_flow) and data.
5757
@@ -69,7 +69,7 @@ class $FUNCTION extends $ {
6969
}
7070
```
7171

72-
2. After an entry function is converted into `$nuc`, it runs each statement in [`stack.js`](https://github.com/NucleoidJS/Nucleoid/blob/main/src/stack.js), which is the core part of the runtime because the control flow is managed by stack and the stack decides sequence of statement based on the graph. For example:
72+
2. After an entry function is converted into `$nuc`, it runs each statement in [`stack.js`](https://github.com/NucleoidAI/Nucleoid/blob/main/src/stack.js), which is the core part of the runtime because the control flow is managed by stack and the stack decides sequence of statement based on the graph. For example:
7373

7474
```javascript
7575
class Item {

docusaurus.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const config = {
1010
onBrokenLinks: "warn",
1111
onBrokenMarkdownLinks: "warn",
1212
favicon: "https://cdn.nucleoid.com/media/icon.png",
13-
organizationName: "NucleoidJS",
13+
organizationName: "NucleoidAI",
1414
projectName: "Nucleoid",
1515
titleDelimiter: "-",
1616
i18n: {
@@ -35,7 +35,7 @@ const config = {
3535
docs: {
3636
routeBasePath: "/",
3737
sidebarPath: require.resolve("./sidebars.js"),
38-
editUrl: "https://github.com/NucleoidJS/docs/tree/main/",
38+
editUrl: "https://github.com/NucleoidAI/docs/tree/main/",
3939
},
4040
blog: false,
4141
theme: {
@@ -69,7 +69,7 @@ const config = {
6969
position: "right",
7070
},
7171
{
72-
href: "https://github.com/NucleoidJS/Nucleoid",
72+
href: "https://github.com/NucleoidAI/Nucleoid",
7373
html: require("fs").readFileSync("./github.html", "utf8"),
7474
position: "right",
7575
},

src/components/Footer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ function Footer() {
2020
></IconButton>
2121
<IconButton
2222
onClick={() =>
23-
window.open("https://twitter.com/NucleoidJS", "_blank")
23+
window.open("https://twitter.com/NucleoidAI", "_blank")
2424
}
2525
>
2626
<TwitterIcon style={{ fill: "#ffffff" }} />
2727
</IconButton>
2828
<IconButton
2929
onClick={() =>
30-
window.open("https://github.com/NucleoidJS/Nucleoid", "_blank")
30+
window.open("https://github.com/NucleoidAI/Nucleoid", "_blank")
3131
}
3232
>
3333
<GitHubIcon style={{ fill: "#ffffff" }} />

0 commit comments

Comments
 (0)