Skip to content

Commit d527f95

Browse files
jdevalkcostdev
andauthored
Do plugin rename (#78)
Signed-off-by: Joost de Valk <[email protected]> Co-authored-by: Colin Stewart <[email protected]>
1 parent 0b945d3 commit d527f95

25 files changed

+210
-210
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff 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.
33
## 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.
55

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.
77
## Requirements
88
- PHP 8.3 or higher
99
- 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
1313
## Local Installation & Development Setup
1414
### 1. Clone the Repository
1515
```bash
16-
git clone https://github.com/fairpm/mini-fair-repo.git
17-
cd mini-fair-repo
16+
git clone https://github.com/fairpm/fair-beacon.git
17+
cd fair-beacon
1818
```
1919
### 2. Install Dependencies
2020
Install PHP dependencies using Composer:
@@ -32,28 +32,28 @@ This will install the required packages:
3232
- [XAMPP](https://www.apachefriends.org/)
3333
- [MAMP](https://www.mamp.info/)
3434
- [Docker](https://github.com/docker/awesome-compose/tree/master/wordpress-mysql)
35-
2. Copy the Mini FAIR plugin to your WordPress plugins directory:
35+
2. Copy the FAIR Beacon plugin to your WordPress plugins directory:
3636
```bash
37-
cp -r /path/to/mini-fair-repo /path/to/wordpress/wp-content/plugins/mini-fair
37+
cp -r /path/to/fair-beacon /path/to/wordpress/wp-content/plugins/fair-beacon
3838
```
3939
3. Activate the plugin through the WordPress admin interface or via WP-CLI:
4040
```bash
41-
wp plugin activate mini-fair
41+
wp plugin activate fair-beacon
4242
```
4343
#### Option B: Using WP-CLI for Development
4444
If you have WP-CLI installed, you can quickly set up a development environment:
4545
```bash
4646
# Create a new WordPress installation
4747
wp core download
48-
wp config create --dbname=minifair_dev --dbuser=root --dbpass=password
49-
wp core install --url=http://localhost --title=“Mini FAIR Dev” --admin_user=admin --admin_password=password [email protected]
48+
wp config create --dbname=fair_beacon_dev --dbuser=root --dbpass=password
49+
wp core install --url=http://localhost --title=“FAIR Beacon Dev” --admin_user=admin --admin_password=password [email protected]
5050
# Create a symlink to the plugin
51-
ln -s /path/to/mini-fair-repo wp-content/plugins/mini-fair
51+
ln -s /path/to/fair-beacon wp-content/plugins/fair-beacon
5252
# Activate the plugin
53-
wp plugin activate mini-fair
53+
wp plugin activate fair-beacon
5454
```
5555
### 4. Install Git Updater
56-
Mini FAIR requires Git Updater for package management:
56+
FAIR Beacon requires Git Updater for package management:
5757
```bash
5858
# Download and install Git Updater
5959
wp plugin install https://github.com/afragen/git-updater/archive/refs/heads/master.zip --activate
@@ -68,22 +68,22 @@ define(‘WP_DEBUG_DISPLAY’, false);
6868
define(‘SCRIPT_DEBUG’, true);
6969
```
7070
#### Enable WP-CLI Commands
71-
Mini FAIR includes WP-CLI commands for PLC management. Ensure WP-CLI is installed and available in your development environment.
71+
FAIR Beacon includes WP-CLI commands for PLC management. Ensure WP-CLI is installed and available in your development environment.
7272
### 6. Verify Installation
7373
1. Check that the plugin is active:
7474
```bash
7575
wp plugin list
7676
```
7777
2. Verify the REST API endpoint is working:
7878
```bash
79-
curl http://your-site.local/wp-json/minifair/v1/packages
79+
curl http://your-site.local/wp-json/fair-beacon/v1/packages
8080
```
81-
3. Access the Mini FAIR admin page at:
82-
`http://your-site.local/wp-admin/admin.php?page=minifair`
81+
3. Access the FAIR Beacon admin page at:
82+
`http://your-site.local/wp-admin/admin.php?page=fair-beacon`
8383
## Development Workflow
8484
### Project Structure
8585
```
86-
mini-fair-repo/
86+
fair-beacon/
8787
├── plugin.php # Main plugin file
8888
├── composer.json # PHP dependencies
8989
├── inc/ # Core functionality
@@ -98,7 +98,7 @@ mini-fair-repo/
9898
### Key Components
9999
- **PLC Integration**: Handles Decentralized Identifiers (DIDs) for packages
100100
- **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}`)
102102
- **Admin Interface**: WordPress dashboard integration for managing DIDs and packages
103103
### Making Changes
104104
1. **PHP Code**: Edit files in the `inc/` directory
@@ -111,12 +111,12 @@ mini-fair-repo/
111111
- Check WordPress debug logs in `wp-content/debug.log`
112112
- Use `error_log()` for debugging output
113113
- Monitor the REST API responses for package metadata
114-
## Using Mini FAIR
114+
## Using FAIR Beacon
115115
### 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.
118118
### 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…”
120120
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.
121121
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!**
122122
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://...
139139
```
140140
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.
141141
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).
143143
## Contributing
144144
We welcome contributions! Please see [the TSC repository](https://github.com/fairpm/tsc) for contribution guidelines, including the code of conduct.
145145
### Development Setup for Contributors

composer.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "fairpm/mini-fair-repo",
2+
"name": "fairpm/fair-beacon",
33
"description": "Transform your WP site into a FAIR Package Management Repository",
44
"type": "wordpress-plugin",
55
"license": "GPL-2.0-or-later",
@@ -9,10 +9,10 @@
99
"name": "FAIR Contributors"
1010
}
1111
],
12-
"homepage": "https://github.com/fairpm/mini-fair-repo",
12+
"homepage": "https://github.com/fairpm/fair-beacon",
1313
"support": {
14-
"issues": "https://github.com/fairpm/mini-fair-repo/issues",
15-
"source": "https://github.com/fairpm/mini-fair-repo"
14+
"issues": "https://github.com/fairpm/fair-beacon/issues",
15+
"source": "https://github.com/fairpm/fair-beacon"
1616
},
1717
"require": {
1818
"php": ">=8.3",

0 commit comments

Comments
 (0)