You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# Mini FAIR Repo
2
-
The Mini FAIR plugin transforms your site into a [FAIR Repository](https://github.com/fairpm/fair-protocol), allowing you to serve packages directly from your own infrastructure into the FAIR system.
1
+
# FAIR Beacon Repo
2
+
The FAIR Beacon plugin transforms your site into a [FAIR Repository](https://github.com/fairpm/fair-protocol), allowing you to serve packages directly from your own infrastructure into the FAIR system.
3
3
## Design Goals
4
-
Mini FAIR is designed to allow plugin and theme vendors to host their own FAIR repository easily, integrating with tools they’re already using. Mini FAIR is built for small scale hosting for a few packages, not for general use as a mass-hosting repository.
4
+
FAIR Beacon is designed to allow plugin and theme vendors to host their own FAIR repository easily, integrating with tools they’re already using. FAIR Beacon is built for small scale hosting for a few packages, not for general use as a mass-hosting repository.
5
5
6
-
We aim to make it possible for everyone to run Mini FAIR, with a focus on ease of use and integration with existing tooling.
6
+
We aim to make it possible for everyone to run FAIR Beacon, with a focus on ease of use and integration with existing tooling.
7
7
## Requirements
8
8
- PHP 8.3 or higher
9
9
- WordPress 6.4 or higher
@@ -13,8 +13,8 @@ We aim to make it possible for everyone to run Mini FAIR, with a focus on ease o
-**PLC Integration**: Handles Decentralized Identifiers (DIDs) for packages
100
100
-**Git Updater Provider**: Integrates with Git Updater for package management
101
-
-**REST API**: Provides endpoints for package metadata (`/wp-json/minifair/v1/packages/{did}`)
101
+
-**REST API**: Provides endpoints for package metadata (`/wp-json/fair-beacon/v1/packages/{did}`)
102
102
-**Admin Interface**: WordPress dashboard integration for managing DIDs and packages
103
103
### Making Changes
104
104
1.**PHP Code**: Edit files in the `inc/` directory
@@ -111,12 +111,12 @@ mini-fair-repo/
111
111
- Check WordPress debug logs in `wp-content/debug.log`
112
112
- Use `error_log()` for debugging output
113
113
- Monitor the REST API responses for package metadata
114
-
## Using Mini FAIR
114
+
## Using FAIR Beacon
115
115
### Installation for End Users
116
-
Mini FAIR currently supports integration with [Git Updater](https://git-updater.com/), with planned support for other tools such as EDD coming soon.
117
-
To use Mini FAIR, install the latest version of plugin as well as a supported tool - that is, Git Updater.
116
+
FAIR Beacon currently supports integration with [Git Updater](https://git-updater.com/), with planned support for other tools such as EDD coming soon.
117
+
To use FAIR Beacon, install the latest version of plugin as well as a supported tool - that is, Git Updater.
118
118
### Creating a DID for your package
119
-
Once you’ve got Mini FAIR installed, you’ll need to create a DID for your package if you don’t already have one. Head to the Mini FAIR page in your WordPress dashboard, and click “Create New PLC DID…”
119
+
Once you’ve got FAIR Beacon installed, you’ll need to create a DID for your package if you don’t already have one. Head to the FAIR Beacon page in your WordPress dashboard, and click “Create New PLC DID…”
120
120
This will begin the process of creating a new PLC DID for your package - a globally-unique ID identifying your package, which you can take with you even if you change repositories in the future.
121
121
It will also create two cryptographic keys: a “rotation” key, used to manage the DID’s details, as well as a “verification key”, which is used to sign releases. These keys will be stored in your WordPress database - **don’t lose them, as you can’t recover your DID if you lose your rotation key!**
122
122
Once your DID has been created, it’ll be published [in the global PLC Directory](https://web.plc.directory/resolve) if you want to double check it. You can also sync changes to the directory via the Dashboard if your site’s URL changes, or (coming soon!) to rotate your keys.
@@ -139,7 +139,7 @@ Theme URI: Https://...
139
139
```
140
140
Ensure your plugin or theme is set up correctly with [Git Updater](https://git-updater.com/knowledge-base/), and that you’re using the same site as you registered your DID with.
141
141
Once that’s done, you’re ready to go - your package should integrate automatically with the FAIR system! You can use the [FAIR Plugin](https://github.com/fairpm/fair-plugin) to install your package directly by ID, and once it’s been installed once, discovery aggregators will start to list it.
142
-
You can double-check your packages by checking the REST API endpoint at `/wp-json/minifair/v1/packages/{did}` (replace `{did}` with your package’s DID).
142
+
You can double-check your packages by checking the REST API endpoint at `/wp-json/fair-beacon/v1/packages/{did}` (replace `{did}` with your package’s DID).
143
143
## Contributing
144
144
We welcome contributions! Please see [the TSC repository](https://github.com/fairpm/tsc) for contribution guidelines, including the code of conduct.
0 commit comments