From 34a04618924f45736d4eca3c173f14b5d352238c Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 25 Apr 2025 16:06:40 +0100 Subject: [PATCH 1/6] add readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..277f05b --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# SAFE.Utils + +SAFE.Utils provides essential utilities for building [SAFE](https://safe-stack.github.io/) applications. It's distributed as two NuGet packages: +- [SAFE.Client.Utils][![NuGet](https://img.shields.io/nuget/v/SAFE.Client.Utils.svg)](https://www.nuget.org/packages/SAFE.Client.Utils/)(https://www.nuget.org/packages/SAFE.Client.Utils/) - Utilities for client-side code +- [SAFE.Server.Utils][![NuGet](https://img.shields.io/nuget/v/SAFE.Server.Utils.svg)](https://www.nuget.org/packages/SAFE.Server.Utils/)(https://www.nuget.org/packages/SAFE.Server.Utils/) - Utilities for server-side code + +While designed to work together in SAFE applications, each package can be used independently in F# applications. + +## Features +The included functionalities are: + +### SAFE.Client.Utils +* Types to represent remote data on the front end, and Elmish messages deal with remote requests +* Functions that help you get started with Fable.Remoting + +### SAFE.Server.Utils +* Functions that help you get started with Fable.Remoting + + +## Installation + +```fsharp +// In your client project +dotnet add package SAFE.Client.Utils + +// In your server project +dotnet add package SAFE.Server.Utils + + +If you have any questions, please open an issue on the [GitHub repository](https://github.com/SAFE-Stack/SAFE.Utils) \ No newline at end of file From d548e9f16272ed6f8f7e212a346ab200c3758196 Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 25 Apr 2025 16:08:01 +0100 Subject: [PATCH 2/6] move badges --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 277f05b..8a9d7c8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ # SAFE.Utils + + SAFE.Utils provides essential utilities for building [SAFE](https://safe-stack.github.io/) applications. It's distributed as two NuGet packages: -- [SAFE.Client.Utils][![NuGet](https://img.shields.io/nuget/v/SAFE.Client.Utils.svg)](https://www.nuget.org/packages/SAFE.Client.Utils/)(https://www.nuget.org/packages/SAFE.Client.Utils/) - Utilities for client-side code -- [SAFE.Server.Utils][![NuGet](https://img.shields.io/nuget/v/SAFE.Server.Utils.svg)](https://www.nuget.org/packages/SAFE.Server.Utils/)(https://www.nuget.org/packages/SAFE.Server.Utils/) - Utilities for server-side code + +SAFE.Client.Utils - Utilities for client-side code + [![NuGet](https://img.shields.io/nuget/v/SAFE.Client.Utils.svg)](https://www.nuget.org/packages/SAFE.Client.Utils/) + +SAFE.Server.Utils - Utilities for server-side code [![NuGet](https://img.shields.io/nuget/v/SAFE.Server.Utils.svg)](https://www.nuget.org/packages/SAFE.Server.Utils/) While designed to work together in SAFE applications, each package can be used independently in F# applications. From 128c1f14352a1809bd2f86ed4ff59dd25b11fead Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 25 Apr 2025 16:14:38 +0100 Subject: [PATCH 3/6] bullet points --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a9d7c8..c039ea1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ SAFE.Utils provides essential utilities for building [SAFE](https://safe-stack.github.io/) applications. It's distributed as two NuGet packages: -SAFE.Client.Utils - Utilities for client-side code +- SAFE.Client.Utils - Utilities for client-side code [![NuGet](https://img.shields.io/nuget/v/SAFE.Client.Utils.svg)](https://www.nuget.org/packages/SAFE.Client.Utils/) -SAFE.Server.Utils - Utilities for server-side code [![NuGet](https://img.shields.io/nuget/v/SAFE.Server.Utils.svg)](https://www.nuget.org/packages/SAFE.Server.Utils/) +- SAFE.Server.Utils - Utilities for server-side code [![NuGet](https://img.shields.io/nuget/v/SAFE.Server.Utils.svg)](https://www.nuget.org/packages/SAFE.Server.Utils/) While designed to work together in SAFE applications, each package can be used independently in F# applications. From f4d94b9619fd3bf4afb28f54471ec8cb40480f5b Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 25 Apr 2025 16:15:11 +0100 Subject: [PATCH 4/6] close unclosed code block --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c039ea1..dd80d3c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,6 @@ dotnet add package SAFE.Client.Utils // In your server project dotnet add package SAFE.Server.Utils - +``` If you have any questions, please open an issue on the [GitHub repository](https://github.com/SAFE-Stack/SAFE.Utils) \ No newline at end of file From 24016223c5121e0c3e6bbea3ac262a19aa44e15f Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 9 May 2025 11:20:14 +0100 Subject: [PATCH 5/6] Update README.md Co-authored-by: Jaz Thomson --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index dd80d3c..146e70c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # SAFE.Utils - - SAFE.Utils provides essential utilities for building [SAFE](https://safe-stack.github.io/) applications. It's distributed as two NuGet packages: - SAFE.Client.Utils - Utilities for client-side code From c8dfa03ae890c0b610347acb6b2a95fa5bcbe2da Mon Sep 17 00:00:00 2001 From: Joost Kaptein Date: Fri, 9 May 2025 11:20:23 +0100 Subject: [PATCH 6/6] Update README.md Co-authored-by: Jaz Thomson --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 146e70c..9680ebf 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,6 @@ The included functionalities are: ### SAFE.Server.Utils * Functions that help you get started with Fable.Remoting - ## Installation ```fsharp