zumito-framework 1.2.12 → 1.2.13
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.
- package/package.json +1 -1
- package/readme.md +9 -12
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -22,10 +22,10 @@
|
|
|
22
22
|
<p align="center">
|
|
23
23
|
Fast and scalable discord bot framework to jumpstart your projects!
|
|
24
24
|
<br />
|
|
25
|
-
<a href="https://docs.zumito.
|
|
25
|
+
<a href="https://docs.zumito.dev/"><strong>Explore the docs »</strong></a>
|
|
26
26
|
<br />
|
|
27
27
|
<br />
|
|
28
|
-
<a href="
|
|
28
|
+
<a href="#">View Demo (Coming soon)</a>
|
|
29
29
|
·
|
|
30
30
|
<a href="https://github.com/ZumitoTeam/zumito-framework/issues">Report Bug</a>
|
|
31
31
|
·
|
|
@@ -72,7 +72,7 @@ With this framework, you can easily create a feature-rich bot that solves a prob
|
|
|
72
72
|
|
|
73
73
|
The framework is constantly evolving, with new features and updates being added on a regular basis. You can also suggest changes and contribute to the development of the framework by forking the repo and creating a pull request or opening an issue. Thanks to all the contributors who have helped expand this framework!
|
|
74
74
|
|
|
75
|
-
To get started, simply visit the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.
|
|
75
|
+
To get started, simply visit the quickstart guide at [docs.zumito.ga/docs/custom/quickstart](https://docs.zumito.dev/guides/start/) and start building your bot today!
|
|
76
76
|
|
|
77
77
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
78
78
|
|
|
@@ -85,9 +85,7 @@ This section lists the major frameworks and libraries that the framework is buil
|
|
|
85
85
|
* [Node.js](https://nodejs.org/en/)
|
|
86
86
|
* [TypeScript](https://www.typescriptlang.org/)
|
|
87
87
|
* [Discord.js](https://discord.js.org/#/)
|
|
88
|
-
* [MongoDB](https://www.mongodb.com/)
|
|
89
88
|
* [Express](https://expressjs.com/)
|
|
90
|
-
* [Mongoose](https://mongoosejs.com/)
|
|
91
89
|
|
|
92
90
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
93
91
|
|
|
@@ -98,7 +96,7 @@ This section lists the major frameworks and libraries that the framework is buil
|
|
|
98
96
|
|
|
99
97
|
This is a guide of how you can set up the project locally to start contributing to the framework.
|
|
100
98
|
|
|
101
|
-
:warning: If you're here to create your own bot, refer to the quickstart guide at [docs.zumito.
|
|
99
|
+
:warning: If you're here to create your own bot, refer to the quickstart guide at [docs.zumito.dev/guides/start](https://docs.zumito.dev/guides/start/).
|
|
102
100
|
|
|
103
101
|
### Prerequisites
|
|
104
102
|
|
|
@@ -135,7 +133,7 @@ For build the source code, run the following command:
|
|
|
135
133
|
npm run build
|
|
136
134
|
```
|
|
137
135
|
|
|
138
|
-
Then for test it, you will need to create a bot, you can find a guide [here](https://docs.zumito.
|
|
136
|
+
Then for test it, you will need to create a bot, you can find a guide [here](https://docs.zumito.dev/guides/start).
|
|
139
137
|
|
|
140
138
|
for link the framework to your bot, you will need to run these commands
|
|
141
139
|
1. In the root of framework:
|
|
@@ -148,8 +146,6 @@ for link the framework to your bot, you will need to run these commands
|
|
|
148
146
|
npm link zumito-framework
|
|
149
147
|
```
|
|
150
148
|
|
|
151
|
-
_For more info of the framework, please refer to the [Documentation](https://docs.zumito.ga/docs/category/zumito-framework)_
|
|
152
|
-
|
|
153
149
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
154
150
|
|
|
155
151
|
|
|
@@ -157,9 +153,9 @@ _For more info of the framework, please refer to the [Documentation](https://doc
|
|
|
157
153
|
<!-- ROADMAP -->
|
|
158
154
|
## Roadmap
|
|
159
155
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
156
|
+
<!-- issueTable -->
|
|
157
|
+
|
|
158
|
+
<!-- issueTable -->
|
|
163
159
|
|
|
164
160
|
See the [open issues](https://github.com/ZumitoTeam/zumito-framework/issues) for a full list of proposed features (and known issues).
|
|
165
161
|
|
|
@@ -209,6 +205,7 @@ Any questions or suggestions? Come to our [Discord server](https://discord.gg/rF
|
|
|
209
205
|
We would like to thank the following projects for their inspiration and/or help:
|
|
210
206
|
|
|
211
207
|
* [Discord.js](https://discord.js.org)
|
|
208
|
+
* [Caminte](https://github.com/biggora/caminte)
|
|
212
209
|
|
|
213
210
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
214
211
|
|