makepack 1.5.10 → 1.5.12
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
CHANGED
|
@@ -1,9 +1,61 @@
|
|
|
1
|
-
import fs from 'fs-extra'
|
|
2
|
-
import path from 'path'
|
|
3
1
|
|
|
4
|
-
export default async () => {
|
|
5
|
-
|
|
6
|
-
const content =
|
|
2
|
+
export default async (info) => {
|
|
3
|
+
let pkgname = info.projectDirName
|
|
4
|
+
const content = `# ${pkgname}
|
|
5
|
+
|
|
6
|
+
[](https://www.npmjs.com/package/${pkgname})
|
|
7
|
+
[](https://github.com/your-username/${pkgname}/blob/main/LICENSE)
|
|
8
|
+
[](https://www.npmjs.com/package/${pkgname})
|
|
9
|
+
|
|
10
|
+
A brief description of what your package does and its purpose.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
\`\`\`sh
|
|
15
|
+
npm install ${pkgname}
|
|
16
|
+
\`\`\`
|
|
17
|
+
|
|
18
|
+
or with yarn:
|
|
19
|
+
|
|
20
|
+
\`\`\`sh
|
|
21
|
+
yarn add ${pkgname}
|
|
22
|
+
\`\`\`
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
\`\`\`js
|
|
27
|
+
import { feature } from "${pkgname}";
|
|
28
|
+
|
|
29
|
+
const result = feature("example");
|
|
30
|
+
console.log(result);
|
|
31
|
+
\`\`\`
|
|
32
|
+
|
|
33
|
+
## API
|
|
34
|
+
|
|
35
|
+
### \`feature(input: string): string\`
|
|
36
|
+
Description of the function and its parameters.
|
|
37
|
+
|
|
38
|
+
## Configuration (if applicable)
|
|
39
|
+
Explain any configuration options if your package requires setup.
|
|
40
|
+
|
|
41
|
+
## Examples
|
|
42
|
+
Provide additional usage examples for clarity.
|
|
43
|
+
|
|
44
|
+
## Contributing
|
|
45
|
+
Contributions are welcome! Please follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
|
|
50
|
+
|
|
51
|
+
## Links
|
|
52
|
+
- [GitHub Repository](https://github.com/your-username/${pkgname})
|
|
53
|
+
- [NPM Package](https://www.npmjs.com/package/${pkgname})
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
Feel free to modify this template based on your package's specific needs.
|
|
58
|
+
`;
|
|
7
59
|
return {
|
|
8
60
|
content,
|
|
9
61
|
filename: `readme.md`
|