diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..35fe71b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 surenpoghosian + +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. diff --git a/README.md b/README.md index 57cdf0b..d0e242c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ # Code Diagnose -`analyze-project --directory /path/to/your/project` \ No newline at end of file + +**Code Diagnose** is a CLI tool for detecting software antipatterns in your TypeScript projects. It helps identify code smells and improve code quality by analyzing your codebase for common design issues. + +### Installation +To install Code Diagnose, run: + +`npm install -g code-diagnose` + +### Usage +To analyze your TypeScript project, use the following command: + +`analyze-project --directory /path/to/your/project` + +Replace /path/to/your/project with the path to the directory of your TypeScript project. + +### Configuration + +**.diagnoseignore** + +You can exclude specific files or directories from being analyzed by creating a .diagnoseignore file in the root of your project. This file should list the files and directories to ignore, one per line. For example: + +``` +# Ignore all files in the node_modules directory +node_modules/ + +# Ignore specific files +src/ignore-this-file.ts +``` + +### Beta Version + +Please note that Code Diagnose is currently in beta and still under development. Features and functionality may change as development progresses. Feedback and contributions are welcome! + +### Contributing + +If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on [GitHub](https://github.com/surenpoghosian/code-diagnose) + +### License + +This project is licensed under the MIT License - see the [LICENSE](https://github.com/surenpoghosian/code-diagnose/blob/main/LICENSE) file for details. + +Feel free to adjust any sections to better fit your project’s specifics or any additional details you’d like to include! \ No newline at end of file