Skip to content

Commit f7cb479

Browse files
committed
updated the README and the LICENCE
1 parent 6215e2d commit f7cb479

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

LICENCE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) Kushagra Singh Bisen 2022. All rights reserved.
1+
This code is copyrighted by [Ghent University - imec](https://www.ugent.be/ea/idlab/en)
22

33
Permission is hereby granted, free of charge, to any person obtaining a
44
copy of this software and associated documentation files (the "Software"),

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
# Name of the package
1+
## Solid Stream Registry
22

3-
# Usage
3+
The Solid Stream Registry is a service which works on top of one or more Solid Pods to provide an immediate cache for the clients to consume the streaming data stored in the Solid Pods. The Stream Registry maintains state with the Solid Pods and provides a REST API for the clients to interact with the registry instead of the Solid Pods directly. As the experiment done by the maintainers of [CSS](https://github.com/CommunitySolidServer/CommunitySolidServer) demonstrated [here](https://github.com/CommunitySolidServer/CommunitySolidServer/issues/1843#issuecomment-1948600398), the different configurations of the Solid Server can handle around 1k - 2k concurrent GET requests. Some configurations however, such as using the distributed locking approach with the Redis server, it can handle around 15k requests. However, only when the lock expiration time is set to a maximum of 5 minutes (which is not feasible). In cases where there are 3k concurrent GET requests, the response time for the requests is too high. In the expriment done, it took around 17 seconds to respond to 3k concurrent GET requests. This is not feasible for a real-time application as the 2999th client will have to wait for 17 seconds to get the response. The Solid Stream Registry is designed to solve this problem by providing a cache for the clients to consume the streaming data stored in the Solid Pods.
44

5-
# License
5+
## License
6+
This code is copyrighted by [Ghent University - imec](https://www.ugent.be/ea/idlab/en) and released under the [MIT License](./LICENSE).
7+
8+
## Contact
9+
10+
For any questions, please contact [Kush](mailto:[email protected]) or create an issue in the repository [here](https://github.com/argahsuknesib/solid-stream-registry/issues).

0 commit comments

Comments
 (0)