From e82dafd784022f5ac50efd85722f808d5fe26371 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Sat, 23 Mar 2024 16:09:59 +0100 Subject: [PATCH] docs: updated README and corrected the copyright year in the license --- LICENSE | 2 +- README.md | 36 ++++++++++++++++++++++++++++++++++-- 2 files changed, 35 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index 9e0ea66..7cbab64 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright 2023 antifallobst +Copyright 2024 antifallobst 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 diff --git a/README.md b/README.md index 9dda443..62f2eb4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,37 @@ # ICRC - Internet Cipher Relay Chat -Basically IRC but encrypted. +ICRC is a chat protocol / system designed similar to IRC, but it has a heavy focus on security and privacy. +All messages in a relay are end-to-end encrypted using strong encryption schemes. +Messages are not saved persistent on the server, but only routed through the server. +The only public identity a user has is a UUID, that is also unique per relay. -Docs (Usage, API, etc.) will follow. \ No newline at end of file +## Project Status + +ICRC is at the moment work in progress and not functional yet. +[Contribution](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/contribution_guide.md) is very +welcome :) + +## Documentation + +Shortcuts to different documentation parts: + +- [Server API](https://git.nerdcult.net/antifallobst/icrc-server/src/branch/master/docs/api.md) (WIP) +- Server Admin Docs (Coming Soon) + +## License (MIT) + +``` +Copyright 2024 antifallobst + +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. +``` \ No newline at end of file