Skip to content

Commit 303afb2

Browse files
committed
Enhance README with detailed sections and usage guide
Added several new sections to the README to improve documentation: - Download: Instructions for downloading FlowPack. - Usage: Details on using the CLI with an example command. - Package Structure: Explanation of `.fspack` file contents. - Plugin Metadata Example: Example `manifest.json` structure. - Related Projects: Link to FlowSynx.PluginCore repository. - License: MIT License details and link to LICENSE file. - Contributing: Guidelines for contributions and pull requests. - Support: Instructions for reporting issues on GitHub. These updates improve usability, clarity, and community engagement. #18
1 parent 2889375 commit 303afb2

1 file changed

Lines changed: 8 additions & 24 deletions

File tree

README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,11 @@ FlowPack is a .NET packaging utility for building, packaging, and distributing F
1212
- Includes a plugin loader for dynamic plugin loading/unloading.
1313
- Simple CLI
1414

15-
---
16-
17-
## 📦 Download
15+
## Download
1816

1917
Download the latest version of FlowPack from the [Release page](https://github.com/flowsynx/flowpack/releases) and extract it.
2018

21-
---
22-
23-
## 🚀 Usage
19+
## Usage
2420

2521
### Command Line Interface (CLI)
2622

@@ -50,19 +46,15 @@ This will:
5046
2. Publish the plugin.
5147
3. Package it as `MyPlugin.fspack`.
5248

53-
---
54-
55-
## 📂 Package Structure
49+
## Package Structure
5650

5751
A `.fspack` file is a ZIP archive containing:
5852

5953
- `<PluginName>.plugin` - The compiled plugin DLLs and dependencies.
6054
- `manifest.json` - Metadata about the plugin.
6155
- `<PluginName>.plugin.sha256` - SHA256 checksum of the plugin file.
6256

63-
---
64-
65-
## 📝 Plugin Metadata Example
57+
## Plugin Metadata Example
6658

6759
The `manifest.json` file contains metadata like:
6860

@@ -82,26 +74,18 @@ The `manifest.json` file contains metadata like:
8274
}
8375
```
8476

85-
---
86-
87-
## 🔗 Related Projects
77+
## Related Projects
8878

8979
- [FlowSynx.PluginCore](https://github.com/flowsynx/plugin-core): Core interfaces for FlowSynx plugin systems.
9080

91-
---
92-
93-
## 📜 License
81+
## License
9482

9583
This project is licensed under the MIT License. See LICENSE for details.
9684

97-
---
98-
99-
## 👨‍💻 Contributing
85+
## Contributing
10086

10187
Contributions are welcome! Please open an issue or submit a pull request.
10288

103-
---
104-
105-
## 🆘 Support
89+
## Support
10690

10791
For questions or issues, please create an issue on the [GitHub repository](https://github.com/flowsynx/flowpack/issues).

0 commit comments

Comments
 (0)