Skip to content

Commit

Permalink
Fix out-of-date information in README.md (#501)
Browse files Browse the repository at this point in the history
Touch-up some outdated information in the SmartRedis README.md

[ committed by @ashao ]
[ reviewed by @amandarichardsonn ]
  • Loading branch information
ashao authored Aug 8, 2024
1 parent 89a66f3 commit d75a85f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<br />
<div display="inline-block">
<a href="https://github.com/CrayLabs/SmartRedis"><b>Home</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://www.craylabs.org/docs/installation.html#smartredis"><b>Install</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://www.craylabs.org/docs/installation_instructions/basic.html#"><b>Install</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://www.craylabs.org/docs/smartredis.html"><b>Documentation</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://join.slack.com/t/craylabs/shared_invite/zt-nw3ag5z5-5PS4tIXBfufu1bIvvr71UA"><b>Slack</b></a>&nbsp;&nbsp;&nbsp;
<a href="https://github.com/CrayLabs"><b>Cray Labs</b></a>&nbsp;&nbsp;&nbsp;
Expand Down Expand Up @@ -51,7 +51,7 @@ SmartSim in any Python, C++, C, or Fortran project.
## Using SmartRedis

SmartRedis installation instructions are currently hosted as part of the
[SmartSim library installation instructions](https://www.craylabs.org/docs/installation_instructions/basic.html#smartredis)
[SmartSim library installation instructions](https://www.craylabs.org/docs/installation_instructions/basic.html#)
Additionally, detailed [API documents](https://www.craylabs.org/docs/api/smartredis_api.html) are also available as
part of the SmartSim documentation.

Expand All @@ -60,8 +60,8 @@ part of the SmartSim documentation.
SmartRedis utilizes the following libraries:

- [NumPy](https://github.com/numpy/numpy)
- [Hiredis](https://github.com/redis/hiredis) 1.1.0
- [Redis-plus-plus](https://github.com/sewenew/redis-plus-plus) 1.3.5
- [Hiredis](https://github.com/redis/hiredis)
- [Redis-plus-plus](https://github.com/sewenew/redis-plus-plus)

## Publications

Expand Down
6 changes: 5 additions & 1 deletion doc/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ To be released at some future point in time

Description

- Update codecov to v4.0.5 for github actions
- Touch-up outdated information in README.md
- Update codecov to v4.5.0 for github actions
- Remove broken oss.redis.com URLs from documentation
- Add option to allow SmartRedis Fortran library to retain the
path to the main client library
Expand All @@ -19,6 +20,9 @@ Description

Detailed Notes

- Update links to install documentation and remove outdated version
numbers in the README.md
([PR501](https://github.com/CrayLabs/SmartRedis/pull/501))
- Update codecov to v4.5.0 for github actions
([PR502](https://github.com/CrayLabs/SmartRedis/pull/502))
- As part of this cleanup, some behaviors of how the libraries were
Expand Down

0 comments on commit d75a85f

Please sign in to comment.