-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5e8b333
commit 575cde7
Showing
1 changed file
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,35 @@ | ||
# deweb-providers | ||
List of DeWeb Providers | ||
# Deweb Providers | ||
|
||
This GitHub repository is a collection of DeWeb providers that can be used by people and tools to allow users to access websites stored on the Massa Blockchain. For more information about DeWeb, please visit the [Massa DeWeb Documentation](https://docs.massa.net/docs/deweb/home). | ||
|
||
## Adding a Provider | ||
|
||
To add your DeWeb provider to this repository, please follow these steps: | ||
|
||
1. Create a new YAML file in the `providers` directory. | ||
2. Name the file to match your provider's name. | ||
3. Ensure the file follows the format specified in `schema.yaml`. | ||
4. Submit a pull request with your new file. | ||
5. The pull request will be tested by the CI pipeline to ensure it is valid. | ||
6. If your pull request is valid, it will be reviewed by the Massa team and merged. | ||
|
||
### Example Provider File | ||
|
||
Here is an example of a provider file: | ||
|
||
```yaml | ||
title: Example Provider | ||
url: https://example.com | ||
desc: An example provider for the Massa DeWeb project. | ||
owner: Example Company | ||
contact: | ||
email: [email protected] | ||
telegram: example | ||
``` | ||
You can also take example on the existing providers in the `providers` directory. | ||
|
||
## Accessing the Full List of Providers | ||
Developers can access the full list of providers using the raw file available at the following URL: | ||
|
||
https://github.com/massalabs/Deweb-Providers/raw/refs/heads/main/providers.yaml |