webfast 0.1.24 → 0.1.25
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +21 -3
- package/package.json +1 -1
package/README.md
CHANGED
@@ -84,11 +84,29 @@ module.exports = {
|
|
84
84
|
}
|
85
85
|
}
|
86
86
|
|
87
|
-
|
88
|
-
|
87
|
+
## Important Note on Including WebFast
|
88
|
+
|
89
|
+
When integrating WebFast into your project, consider the following instructions:
|
90
|
+
|
91
|
+
```javascript
|
92
|
+
// If you want to set up your own paths, add "paths: true" when requiring WebFast.
|
93
|
+
// This will prompt WebFast to look for specific folders within your project directory.
|
89
94
|
|
90
|
-
|
95
|
+
const program = require('webfast')({
|
96
|
+
paths: true,
|
97
|
+
path: __dirname
|
98
|
+
});
|
91
99
|
```
|
100
|
+
In this configuration:
|
101
|
+
|
102
|
+
The paths: true option instructs WebFast to search for specific folders within the project directory.
|
103
|
+
|
104
|
+
The path: __dirname parameter sets the base directory for WebFast, where it will look for the following essential folders:
|
105
|
+
|
106
|
+
bots
|
107
|
+
ejs
|
108
|
+
routes
|
109
|
+
Within these folders, you can establish a dynamic setup, as exemplified in the module itself.
|
92
110
|
|
93
111
|
```
|
94
112
|
## License
|