@mochabug/adaptkit 0.1.0-alpha.9 → 0.2.0-alpha.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.
Files changed (10) hide show
  1. package/README.md +13 -5
  2. package/bin/index.js +388 -325
  3. package/bin/index.js.map +1 -1
  4. package/package.json +24 -21
  5. package/bin/gen/google/protobuf/descriptor.d.ts +0 -1799
  6. package/bin/gen/google/protobuf/descriptor.d.ts.map +0 -1
  7. package/bin/gen/mochabug/adapt/plugins/v1/plugins.client.d.ts +0 -46
  8. package/bin/gen/mochabug/adapt/plugins/v1/plugins.client.d.ts.map +0 -1
  9. package/bin/gen/mochabug/adapt/plugins/v1/plugins.d.ts +0 -797
  10. package/bin/gen/mochabug/adapt/plugins/v1/plugins.d.ts.map +0 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # @mochabug/adaptkit 🍄: The Magical CLI for Mochabug Adapt Plugin Development!
1
+ # @mochabug/adaptkit : The Magical CLI for Mochabug Adapt Plugin Development!
2
2
 
3
- Welcome to **@mochabug/adaptkit**! 🍄 Prepare to embark on a whimsical adventure filled with creativity and efficiency! @mochabug/adaptkit is a powerful CLI tool designed to help you *effortlessly* develop and manage plugins for the Mochabug Adapt platform. With @mochabug/adaptkit, you can:
3
+ Welcome to **@mochabug/adaptkit**! Prepare to embark on a whimsical adventure filled with creativity and efficiency! @mochabug/adaptkit is a powerful CLI tool designed to help you *effortlessly* develop and manage plugins for the Mochabug Adapt platform. With @mochabug/adaptkit, you can:
4
4
 
5
5
  - 🌈 Create enchanting template projects for plugin development
6
6
  - 🧙‍♂️ Emulate your plugins in a cloud environment with just a flick of your wand
@@ -47,7 +47,15 @@ adaptkit --emulate
47
47
 
48
48
  Test your plugin's sorcery in a controlled environment by emulating its behavior in the cloud.
49
49
 
50
- 3. **Add and modify vertices**
50
+ In order to do this you need to have docker installed and run the emulator locally using the following command:
51
+
52
+ ```bash
53
+ docker run --rm -it -p 51001:51001 -p 51002:51002 -p 51003:51003 -p 51004:51004 -p 51005:51005 mochabug/adaptsandbox:latest
54
+ ```
55
+
56
+ Note: The 5 ports is required to simulate the different vertex types as well as the graphical interface together with the publish endpoint of adaptkit.
57
+
58
+ 1. **Add and modify vertices**
51
59
 
52
60
  ```bash
53
61
  adaptkit --add-vertex [vertexType] [vertexName]
@@ -65,10 +73,10 @@ Share your magical creation with the world by publishing your plugin to the Moch
65
73
 
66
74
  ## Documentation 📚
67
75
 
68
- For a more comprehensive spellbook on how to use @mochabug/adaptkit and unlock the full potential of our captivating plugin system for Mochabug Adapt, visit our [documentation](https://adaptkit-docs.example.com).
76
+ For a more comprehensive spellbook on how to use @mochabug/adaptkit and unlock the full potential of our captivating plugin system for Mochabug Adapt, visit our [documentation](https://developers.mochabug.com).
69
77
 
70
78
  ## Contribute 🤝
71
79
 
72
- Svampinizer is a collaborative, open-source project, and we welcome your contributions! If you have an idea for a feature, a bug report, or would like to help with documentation, please [open an issue](https://github.com/mochabug/adaptkit/issues) or [submit a pull request](https://github.com/mochabug/svampinizer/pulls).
80
+ @mochabug/adaptkit s is a community-driven, open-source project, and we warmly welcome your contributions! If you have an idea for a new type, a bug report, or would like to help with documentation, please [open an issue](https://github.com/mochabug/mochabug/issues) or [submit a pull request](https://github.com/mochabug/mochabug/pulls).
73
81
 
74
82
  ## A Magical Journey Awaits! 🍄