Skip to content

Commit 4ff2a19

Browse files
committed
Add README.md documentation and LICENSE
1 parent c1e1967 commit 4ff2a19

File tree

2 files changed

+46
-3
lines changed

2 files changed

+46
-3
lines changed

LICENSE

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

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# SOLID principles examples in Java
22

3-
## How To Start
3+
## How to start
44

55
1. Install Java 8
6-
2. Clone this repository `git clone https://github.com/CodelyTV/java-bootstrap`.
6+
2. Clone this repository `git clone https://github.com/CodelyTV/solid-principles-java-examples`.
77
3. Run the tests with `./gradlew test`
8-
4. Start playing around with the different examples of each SOLID principle!
8+
4. Start playing around with the different examples of each SOLID principle. You have the explanations in the test code 🙂
9+
10+
## Liskov Substitution Principle (LSP)
11+
12+
* Package: `tv.codely.solid_principles.liskov_substitution_principle`
13+
* [Production code](src/main/java/tv/codely/solid_principles/liskov_substitution_principle)
14+
* [Tests code with explanations](src/test/java/tv/codely/solid_principles/liskov_substitution_principle)
15+
16+
## Dependency Inversion Principle (DIP)
17+
18+
* Package: `tv.codely.solid_principles.dependency_inversion_principle`
19+
* [Production code](src/main/java/tv/codely/solid_principles/dependency_inversion_principle)
20+
* [Tests code with explanations](src/test/java/tv/codely/solid_principles/dependency_inversion_principle)
21+
22+
## About
23+
24+
This hopefully helpful examples have been implemented by [CodelyTV](https://github.com/CodelyTV) and [contributors](https://github.com/CodelyTV/solid-principles-java-examples/graphs/contributors).
25+
26+
Pull Requests are welcome. We would suggest oppening an issue before actually coding your Pull Request in order to ask for feedback 🙂
27+
28+
## License
29+
30+
The MIT License (MIT). Please see [License](LICENSE) for more information.

0 commit comments

Comments
 (0)