rcf-protocol 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +2 -2
- package/README.md +37 -19
- package/package.json +2 -2
package/LICENSE
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
RESTRICTED CORRELATION FRAMEWORK PROTOCOL LICENSE
|
|
2
|
-
Version 1.1, Effective Date: 2026
|
|
2
|
+
Version 1.1.1, Effective Date: 2026
|
|
3
3
|
|
|
4
|
-
Copyright (c) 2026
|
|
4
|
+
Copyright (c) 2026 Aladdin Aliyev
|
|
5
5
|
All rights reserved.
|
|
6
6
|
|
|
7
7
|
================================================================================
|
package/README.md
CHANGED
|
@@ -1,35 +1,53 @@
|
|
|
1
|
-
# RCF Protocol
|
|
1
|
+
# RCF Protocol — TypeScript SDK
|
|
2
2
|
|
|
3
|
-
The official TypeScript SDK and Command Line Interface for the RCF (
|
|
4
|
-
|
|
3
|
+
The official TypeScript/JavaScript SDK and Command Line Interface for the **RCF (Restricted Correlation Framework) Protocol**.
|
|
4
|
+
|
|
5
|
+
RCF is an author-defined licensing protocol designed to protect intellectual property in the age of automated extraction and AI/ML mass replication. It creates a clear legal and technical boundary between **Visibility** and **Usage Rights**.
|
|
5
6
|
|
|
6
7
|
## Installation
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
# Install the SDK in your project
|
|
10
|
-
npm install rcf-protocol
|
|
9
|
+
Install via NPM:
|
|
11
10
|
|
|
12
|
-
|
|
11
|
+
```bash
|
|
12
|
+
# Install globally to use the CLI anywhere
|
|
13
13
|
npm install -g rcf-protocol
|
|
14
|
+
|
|
15
|
+
# Or install as a dev dependency in your project
|
|
16
|
+
npm install -D rcf-protocol
|
|
14
17
|
```
|
|
15
18
|
|
|
16
19
|
## Features
|
|
17
20
|
|
|
18
|
-
- **Standardized Markers**: Identify
|
|
19
|
-
- **
|
|
20
|
-
- **
|
|
21
|
-
- **TypeScript Native**: Full typing support out of the box.
|
|
22
|
-
|
|
23
|
-
## Core concepts
|
|
24
|
-
|
|
25
|
-
- `@rcf[RequirementID]:` - Embedded directly into comments to link implementation blocks.
|
|
26
|
-
- `RCF Map` - The central source of truth for all requirements, mapped to files/lines.
|
|
21
|
+
- **Standardized Markers Check**: Identify `[RCF:PUBLIC]`, `[RCF:PROTECTED]`, `[RCF:RESTRICTED]`, and `[RCF:NOTICE]` markers in your codebase.
|
|
22
|
+
- **Header Validation**: Ensure files have the required `NOTICE: This file is protected under RCF-PL v1.1` header.
|
|
23
|
+
- **Automated Scanning**: Quickly scan projects for compliance.
|
|
27
24
|
|
|
28
25
|
## CLI Usage
|
|
29
26
|
|
|
30
|
-
The `rcf-cli` binary allows for quick
|
|
27
|
+
The `rcf-cli` binary allows for quick compliance verification of your project.
|
|
31
28
|
|
|
32
29
|
```bash
|
|
33
|
-
#
|
|
34
|
-
rcf-cli
|
|
30
|
+
# Scan the current directory
|
|
31
|
+
rcf-cli .
|
|
32
|
+
|
|
33
|
+
# Scan with custom ignore list (in addition to .rcfignore)
|
|
34
|
+
rcf-cli . --ignore node_modules,dist,.git
|
|
35
35
|
```
|
|
36
|
+
|
|
37
|
+
## Markers Reference
|
|
38
|
+
|
|
39
|
+
RCF uses semantic markers to define protection levels at the block or file level. Place these inside code comments:
|
|
40
|
+
- `[RCF:PUBLIC]` — Architecture and public concepts. Safe to discuss.
|
|
41
|
+
- `[RCF:PROTECTED]` — Core methodology. Visible but **not replicable**.
|
|
42
|
+
- `[RCF:RESTRICTED]` — Highly sensitive implementation. Minimal rights.
|
|
43
|
+
- `[RCF:NOTICE]` — Triggers requirement for adjacent legal notice.
|
|
44
|
+
|
|
45
|
+
Example header for protected files:
|
|
46
|
+
```javascript
|
|
47
|
+
// NOTICE: This file is protected under RCF-PL v1.1
|
|
48
|
+
// [RCF:PROTECTED]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
For full specification and legal framework details, visit the official site: **[rcf.aliyev.site](https://rcf.aliyev.site)**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rcf-protocol",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "RCF Protocol SDK for TypeScript/JavaScript",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"type": "git",
|
|
16
16
|
"url": "git+https://github.com/aliyevaladddin/rcf-protocol.git"
|
|
17
17
|
},
|
|
18
|
-
"license": "
|
|
18
|
+
"license": "RCF",
|
|
19
19
|
"scripts": {
|
|
20
20
|
"build": "tsc",
|
|
21
21
|
"dev": "ts-node src/cli/index.ts",
|