]> go.fuhry.dev Git - fsnotify.git/commitdiff
This project is archived (#459)
authorNathan Youngman <git@nathany.com>
Fri, 8 Jul 2022 16:16:12 +0000 (10:16 -0600)
committerGitHub <noreply@github.com>
Fri, 8 Jul 2022 16:16:12 +0000 (10:16 -0600)
README.md

index 0731c5ef8adc7b020402bf8e06b84b54a57981b7..da09b4156faffdb14107fa1345065dd5c8afab4d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,14 @@
 # File system notifications for Go
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/fsnotify/fsnotify.svg)](https://pkg.go.dev/github.com/fsnotify/fsnotify) [![Go Report Card](https://goreportcard.com/badge/github.com/fsnotify/fsnotify)](https://goreportcard.com/report/github.com/fsnotify/fsnotify) [![Maintainers Wanted](https://img.shields.io/badge/maintainers-wanted-red.svg)](https://github.com/fsnotify/fsnotify/issues/413)
+[![Go Reference](https://pkg.go.dev/badge/github.com/fsnotify/fsnotify.svg)](https://pkg.go.dev/github.com/fsnotify/fsnotify) [![Go Report Card](https://goreportcard.com/badge/github.com/fsnotify/fsnotify)](https://goreportcard.com/report/github.com/fsnotify/fsnotify)
 
-fsnotify utilizes [`golang.org/x/sys`](https://pkg.go.dev/golang.org/x/sys) rather than [`syscall`](https://pkg.go.dev/syscall) from the standard library.
+## This project is archived.
 
-Cross platform: Windows, Linux, BSD and macOS.
+[Details](https://github.com/fsnotify/fsnotify/issues/413) of this decision.
+
+## Cross platform
+
+`fsnotify` supports Windows, Linux, BSD and macOS with a common API.
 
 | Adapter               | OS                               | Status                                                                                                                          |
 | --------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
@@ -21,6 +25,8 @@ Cross platform: Windows, Linux, BSD and macOS.
 
 Please see [the documentation](https://pkg.go.dev/github.com/fsnotify/fsnotify) and consult the [FAQ](#faq) for usage information.
 
+NOTE: fsnotify utilizes [`golang.org/x/sys`](https://pkg.go.dev/golang.org/x/sys) rather than [`syscall`](https://pkg.go.dev/syscall) from the standard library.
+
 ## API stability
 
 fsnotify is a fork of [howeyc/fsnotify](https://github.com/howeyc/fsnotify) with a new API as of v1.0. The API is based on [this design document](http://goo.gl/MrYxyA).