|
6 | 6 |
|
7 | 7 | A community WordPress plugin for **[thirdweb](https://thirdweb.com)**. Turn your WordPress website into Web3 instantly and easily with thirdweb. 💻🌏 |
8 | 8 |
|
9 | | -Have suggestions in mind? Let me know! |
| 9 | +Have suggestions in mind? [Let me know!](https://github.com/warengonzaga/thirdweb-wp/issues) |
| 10 | + |
| 11 | +## ⚡ Features |
| 12 | + |
| 13 | +- Contract Reading Shortcode |
| 14 | +- Contract Writing Shortcode _(Coming Soon)_ |
| 15 | +- Gutenberg Blocks _(Coming Soon)_ |
| 16 | + |
| 17 | +## 📋 Requirements |
| 18 | + |
| 19 | +- [thirdweb Engine URL](https://portal.thirdweb.com/engine/getting-started) |
| 20 | +- [thirdweb Engine Access Token](https://thirdweb.com/dashboard/engine) |
| 21 | +- WordPress 5.0+ |
| 22 | +- PHP 8.1+ |
| 23 | + |
| 24 | +## 📦 Installation |
| 25 | + |
| 26 | +To be able to start using this plugin just [download the latest release here](https://github.com/warengonzaga/thirdweb-wp/releases/latest). |
| 27 | + |
| 28 | +- Upload the plugin (.zip file) to the /wp-content/plugins/ directory. |
| 29 | +- Activate the Update Your Footer WP plugin through the 'Plugins' menu in WordPress. |
| 30 | +- See the usage section below to start using the plugin. |
| 31 | + |
| 32 | +## 🛠️ Setup |
| 33 | + |
| 34 | +1. Go to your WordPress admin dashboard. |
| 35 | +2. Go to `Settings > thirdweb WP`. |
| 36 | +3. Save your thirdweb Engine URL and Access Token. |
| 37 | +4. Click `Save Changes`. |
| 38 | +5. You're all set! 🎉 |
| 39 | + |
| 40 | +> [!NOTE] |
| 41 | +> You can also save your default or global address and chain across your wordpress site. Just go to `Settings > thirdweb WP` and fill the `Default Contract Address` and `Default Chain` fields. Click `Save Changes` to save your settings. |
| 42 | +
|
| 43 | +## 🕹️ Usage |
| 44 | + |
| 45 | +Reading contract address using `[twcontract]` shortcode. |
| 46 | + |
| 47 | +```php |
| 48 | +[twcontract address="0x00..." chain="84531" function="tokenURI:0"] |
| 49 | +``` |
| 50 | + |
| 51 | +- `address` - The contract address. |
| 52 | +- `chain` - The chain name or ID. |
| 53 | +- `function` - The function name and arguments. |
| 54 | + > [!NOTE] |
| 55 | + > `functionName:arg1` for single argument. |
| 56 | + > `functionName:arg1,arg2` for multiple arguments. |
| 57 | +
|
| 58 | +_More features coming soon..._ |
10 | 59 |
|
11 | 60 | ## 🎯 Contributing |
12 | 61 |
|
13 | | -Contributions are welcome, create a pull request to this repo and we'll review your code. Please consider to submit your pull request to the `dev` branch. Thank you! |
| 62 | +Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you! |
14 | 63 |
|
15 | 64 | Read the project's [contributing guide](./contributing.md) for more info. |
16 | 65 |
|
17 | 66 | ## 🐛 Issues |
18 | 67 |
|
19 | | -Please report any issues and bugs by [creating a new issue here](https://github.com/warengonzaga/thirdweb-wp/issues/new), also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨ |
20 | | - |
21 | | -## 🍀 Sponsor |
22 | | - |
23 | | -Love what I do? Send me some [love](https://github.com/sponsors/warengonzaga) or [coffee](https://buymeacoff.ee/warengonzaga)!? 💖☕ |
| 68 | +Please report any issues and bugs by [creating a new issue here](https://github.com/warengonzaga/thirdweb-wp/issues/new/choose), also make sure you're reporting an issue that doesn't exist. Any help to improve the project would be appreciated. Thanks! 🙏✨ |
24 | 69 |
|
25 | | -Can't send love or coffees? 😥 Nominate me for a **[GitHub Star](https://stars.github.com/nominate)** instead! |
| 70 | +## 🙏 Sponsor and Support |
26 | 71 |
|
27 | | -> **Note**: Your support means a lot to me as it allows me to dedicate my time and energy to create and maintain open-source projects that benefits the community. Thank you for supporting my mission to make technology better, accessible and inclusive for everyone. 🙏😇 |
| 72 | +> Love what I do? Send me some [love](https://github.com/sponsors/warengonzaga) or [coffee](https://buymeacoff.ee/warengonzaga)!? 💖☕ |
| 73 | +> |
| 74 | +> Can't send love or coffees? 😥 Nominate me for a **[GitHub Star](https://stars.github.com/nominate)** instead! |
| 75 | +> Your support will help me to continue working on open-source projects like this. 🙏😇 |
28 | 76 |
|
29 | 77 | ## 📋 Code of Conduct |
30 | 78 |
|
31 | 79 | Read the project's [code of conduct](./code_of_conduct.md). |
32 | 80 |
|
33 | 81 | ## 📃 License |
34 | 82 |
|
35 | | -The thirdweb WP is licensed under [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0). |
| 83 | +This project is licensed under [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0). |
36 | 84 |
|
37 | 85 | ## 📝 Author |
38 | 86 |
|
39 | | -The thirdweb WP is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/thirdweb-wp/graphs/contributors). |
| 87 | +This project is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/thirdweb-wp/graphs/contributors). |
40 | 88 |
|
41 | 89 | --- |
42 | 90 |
|
43 | | -💻💖☕ by [Waren Gonzaga](https://warengonzaga.com) | [He is Awesome](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏 |
| 91 | +💻 with ❤️ by [Waren Gonzaga](https://warengonzaga.com) and [Him](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏 |
0 commit comments