Skip to content

Commit c086333

Browse files
committed
doc: adding first readme documentation steps
1 parent 417571f commit c086333

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Gradle Plugin](https://img.shields.io/gradle-plugin-portal/v/com.diffplug.spotless?color=blue&label=gradle%20plugin)](plugin-gradle)
44
[![Maven Plugin](https://img.shields.io/maven-central/v/com.diffplug.spotless/spotless-maven-plugin?color=blue&label=maven%20plugin)](plugin-maven)
55
[![SBT Plugin](https://img.shields.io/badge/sbt%20plugin-0.1.3-blue)](https://github.com/moznion/sbt-spotless)
6+
[![CLI](https://img.shields.io/badge/cli-0.0.1-blue)](cli)
67

78
Spotless can format <antlr | c | c# | c++ | css | flow | graphql | groovy | html | java | javascript | json | jsx | kotlin | less | license headers | markdown | objective-c | protobuf | python | scala | scss | shell | sql | typeScript | vue | yaml | anything> using <gradle | maven | sbt | anything>.
89

@@ -41,6 +42,13 @@ user@machine repo % mvn spotless:check
4142
```
4243

4344
## [❇️ Spotless for SBT (external for now)](https://github.com/moznion/sbt-spotless)
45+
46+
## [❇️ Spotless Command Line Interface (CLI)](cli)
47+
48+
```console
49+
user@machine repo % spotless --target '**/src/**/*.java' license-header --header='/* Myself $YEAR */' google-java-format
50+
```
51+
4452
## [Other build systems](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system)
4553

4654
## How it works (for potential contributors)

cli/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# <img align="left" src="../_images/spotless_logo.png"> Spotless Command Line Interface CLI
2+
*Keep your code Spotless with Gradle*
3+
4+
<!---freshmark shields
5+
output = [
6+
link(shield('Changelog', 'changelog', '{{versionLast}}', 'blue'), 'CHANGES.md'),
7+
'',
8+
link(shield('OS Win', 'OS', 'Windows', 'blueviolet'), 'README.md'),
9+
link(shield('OS Linux', 'OS', 'Linux', 'blueviolet'), 'README.md'),
10+
link(shield('OS macOS', 'OS', 'macOS', 'blueviolet'), 'README.md'),
11+
].join('\n');
12+
-->
13+
[![Changelog](https://img.shields.io/badge/changelog-0.0.1-blue.svg)](CHANGES.md)
14+
15+
[![OS Win](https://img.shields.io/badge/OS-Windows-blueviolet.svg)](README.md)
16+
[![OS Linux](https://img.shields.io/badge/OS-Linux-blueviolet.svg)](README.md)
17+
[![OS macOS](https://img.shields.io/badge/OS-macOS-blueviolet.svg)](README.md)
18+
<!---freshmark /shields -->
19+
20+
`spotless` is a command line interface (CLI) for the [spotless code formatter](../README.md).
21+
It intends to be a simple alternative to its siblings: the plugins for [gradle](../plugin-gradle/README.md), [maven](../plugin-maven/README.md)
22+
and others.
23+
24+
- TODO: add usage and examples
25+
- TBD: can usage be generated automatically e.g. via freshmark?

0 commit comments

Comments
 (0)