diff --git a/README.md b/README.md new file mode 100644 index 0000000..40df2e4 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +.editorconfig CLI +================= + +Features +-------- + +* Command `editorconfig-cli ls [PATH]` - list the files found within `[PATH]` and the .editorconfig + files that would be applied to them. + +* Command `editorconfig-cli rules [PATH]` - list the rules that would be applied to `[PATH]`. + +* There is a single binary you can download that works on Mac, Linx and Windows. No installation +needed! + +* It's open source. + +License +------- + +MIT License + +Copyright (c) 2016 Amy Boyd + +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: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +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.