Skip to content

Commit 5c6dad5

Browse files
committed
Added metadata and project description
1 parent fea2d92 commit 5c6dad5

3 files changed

Lines changed: 72 additions & 0 deletions

File tree

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Alan Płócieniak
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# WebOptimizer CLI
2+
3+
The **WebOptimizer CLI** is a command-line tool for bundling and minification of CSS and JavaScript using [**WebOptimizer**](https://github.com/ligershark/WebOptimizer).
4+
5+
## Description
6+
7+
The WebOptimizer CLI provides a simple interface to create CSS and JS bundles. The `bundle` command has two subcommands: `css` and `js`, each of which requires an output file path and an array of source files.
8+
9+
When you run the `css` subcommand, the tool processes the specified CSS source files and creates a bundled output file. Similarly, the `js` subcommand processes the specified JS source files and creates a bundled output file.
10+
11+
## Installation
12+
13+
To install the WebOptimizer CLI, you need to have .NET 9 installed on your machine. You can then build and run the CLI tool from the source code.
14+
15+
## Usage
16+
17+
The CLI tool provides commands to create CSS and JS bundles. Below are the available commands and their options.
18+
19+
### Commands
20+
21+
#### `bundle`
22+
23+
The `bundle` command is used to create CSS and JS bundles.
24+
25+
##### Subcommands
26+
27+
- `css`: Process CSS bundle
28+
- `js`: Process JS bundle
29+
30+
##### Options
31+
32+
- `--output`, `-o` (required): Output file path for the bundle
33+
- `--sources`, `-s` (required): Array of source files for the bundle
34+
35+
### Examples
36+
37+
#### Create a CSS Bundle
38+
39+
To create a CSS bundle, use the following command:
40+
41+
```pwsh
42+
dotnet run -- bundle css --output path/to/output.css --sources path/to/source1.css path/to/source2.css
43+
```
44+
45+
#### Create a JS Bundle
46+
47+
To create a JS bundle, use the following command:
48+
49+
```pwsh
50+
dotnet run -- bundle js --output path/to/output.js --sources path/to/source1.js path/to/source2.js
51+
```
52+
53+
## Examples
54+
```pwsh
55+
# bundle and minify CSS files using patterns
56+
.\weboptimizer.exe bundle css -s css/**/*.css -o main.min.css
57+
```
58+
59+
## License
60+
61+
[MIT License](LICENSE.md) © Alan Płócieniak

src/WebOptimizerCLI/WebOptimizerCLI.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<TargetFramework>net9.0</TargetFramework>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<Nullable>enable</Nullable>
8+
<AssemblyName>weboptimizer</AssemblyName>
9+
<Version>0.1.0</Version>
810
</PropertyGroup>
911

1012

0 commit comments

Comments
 (0)