Skip to content

Commit 4201cdf

Browse files
docs: Add basic README
1 parent ecabe2d commit 4201cdf

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Scala Server Toolkit
2+
3+
This project is a culmination of years of Scala development at Avast and tries to represent the best practices of Scala server development
4+
we have gained together with tools that allow us to be effective. It is a set of small, flexible and cohesive building blocks that fit
5+
together well and allow you to build reliable server applications.
6+
7+
## Design
8+
9+
There are certain design decisions and constraints that are put in place to guide the development of the toolkit and recommended for
10+
the development of your server applications.
11+
12+
* Keep the number of dependencies as low as possible.
13+
* Modular design: small, cohesive, orthogonal and composable components.
14+
* Functional programming.
15+
* Type safe configuration and resource lifecycle.
16+
* No need for dependency injection.
17+
* [Scalazzi Safe Scala Subset](https://slides.yowconference.com/yowwest2014/Morris-ParametricityTypesDocumentationCodeReadability.pdf)
18+
19+
## Issues
20+
21+
Please report issues to [GitHub](https://github.com/avast/scala-server-toolkit/issues).
22+
23+
## License
24+
25+
Scala Server Toolkit is licensed under [MIT License](LICENSE).

0 commit comments

Comments
 (0)