From eabddfbf320de7f845265465a7f38087fea346c4 Mon Sep 17 00:00:00 2001 From: JordanMartinez Date: Thu, 3 Aug 2023 17:11:38 -0500 Subject: [PATCH] Deprecate repo (#41) * Replace readme with deprecation notice * Add pursuit keyword --- README.md | 39 +++------------------------------------ bower.json | 3 ++- 2 files changed, 5 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 7073dae..c6575d3 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,6 @@ -# purescript-node-fs-aff +# DEPRECATED -[![Latest release](http://img.shields.io/github/release/purescript-node/purescript-node-fs-aff.svg)](https://github.com/purescript-node/purescript-node-fs-aff/releases) -[![Build status](https://github.com/purescript-node/purescript-node-fs-aff/workflows/CI/badge.svg?branch=master)](https://github.com/purescript-node/purescript-node-fs-aff/actions?query=workflow%3ACI+branch%3Amaster) -[![Pursuit](https://pursuit.purescript.org/packages/purescript-node-fs-aff/badge)](https://pursuit.purescript.org/packages/purescript-node-fs-aff) +`purescript-node-fs-aff` is deprecated. Functions and values from this library were merged as-is into the [`purescript-node-fs`](https://github.com/purescript/purescript-node-fs) library. -[Node.FS][node.fs] wrappers for [purescript-aff][aff]. +The [original releases up to v9.2.0](https://github.com/purescript-deprecated/purescript-node-fs-aff/releases) of this library are still available and will work with compiler versions prior to PureScript v0.16.x. -The `Aff` monad lets you write async code with ease, and `node-fs-aff` lets you easily access the filesystem within `Aff`. - -## Installation - -``` -spago install node-fs-aff -``` - -## Example - -Consider asynchronously listing only non-hidden directories: - -```purescript -main = launchAff do - files <- FS.readdir "." - files' <- flip filterM files \file -> do - stat <- FS.stat file - pure $ - FS.isDirectory stat - && (maybe false (fromChar >>> (/= ".")) $ charAt 0 file) - liftEff $ print files' -``` - -That was easy. Run `npm run example` to see it work. - -## Documentation - -Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-node-fs-aff). - -[node.fs]: http://github.com/purescript-node/purescript-node-fs -[aff]: https://github.com/slamdata/purescript-aff diff --git a/bower.json b/bower.json index 4ba77e6..538927d 100644 --- a/bower.json +++ b/bower.json @@ -10,7 +10,8 @@ "description": "Aff wrappers for purescript-node-fs", "keywords": [ "purescript", - "node" + "node", + "pursuit-deprecated" ], "license": "MIT", "homepage": "https://github.com/purescript-node/purescript-node-fs-aff",