fix: Make sure all Readme files are up to date (#3154)

feathersjs · Apr 12, 2023 · a5f0b38 · a5f0b38
1 parent 962bd87
commit a5f0b38
Show file tree

Hide file tree

Showing 23 changed files with 66 additions and 31 deletions.
diff --git a/docs/public/img/feathers-logo-wide.png b/docs/public/img/feathers-logo-wide.png
diff --git a/packages/adapter-commons/README.md b/packages/adapter-commons/README.md
@@ -6,9 +6,15 @@
 
 > Shared utility functions for Feathers adatabase adapters
 
-## About
+## Installation
 
-This is a repository for handling Feathers common database syntax. See the [API documentation](https://docs.feathersjs.com/api/databases/common.html) for more information.
+```
+npm install @feathersjs/adapter-commons --save
+```
+
+## Documentation
+
+Refer to the [Feathers database adapter documentation](https://feathersjs.com/api/databases/common.html) for more details.
 
 ## Authors
 

diff --git a/packages/authentication-client/README.md b/packages/authentication-client/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/authentication-client --save
 
 ## Documentation
 
-Refer to the [Feathers authentication client API documentation](https://docs.feathersjs.com/api/authentication/client.html) for more details.
+Refer to the [Feathers authentication client API documentation](https://feathersjs.com/api/authentication/client.html) for more details.
 
 ## License
 

diff --git a/packages/authentication-local/README.md b/packages/authentication-local/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/authentication-local --save
 
 ## Documentation
 
-Refer to the [Feathers local authentication API documentation](https://docs.feathersjs.com/api/authentication/local.html) for more details.
+Refer to the [Feathers local authentication API documentation](https://feathersjs.com/api/authentication/local.html) for more details.
 
 ## License
 

diff --git a/packages/authentication-oauth/README.md b/packages/authentication-oauth/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/authentication-oauth --save
 
 ## Documentation
 
-Refer to the [Feathers oAuth authentication API documentation](https://docs.feathersjs.com/api/authentication/oauth.html) for more details.
+Refer to the [Feathers oAuth authentication API documentation](https://feathersjs.com/api/authentication/oauth.html) for more details.
 
 ## License
 

diff --git a/packages/authentication/README.md b/packages/authentication/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/authentication --save
 
 ## Documentation
 
-Refer to the [Feathers authentication API documentation](https://docs.feathersjs.com/api/authentication/) for more details.
+Refer to the [Feathers authentication API documentation](https://feathersjs.com/api/authentication/) for more details.
 
 ## License
 

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -19,7 +19,7 @@ $ npx feathers help
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers CLI guide](https://feathersjs.com/guides/cli/) for more details.
 
 ## License
 

diff --git a/packages/commons/README.md b/packages/commons/README.md
@@ -6,9 +6,15 @@
 
 > Shared Feathers utility functions
 
-## About
+## Installation
 
-This is a repository for utility functionality that is shared between different Feathers plugin and used by the main repository.
+```
+npm install @feathersjs/commons --save
+```
+
+## Documentation
+
+Refer to the [Feathers API](https://feathersjs.com/api) for more details.
 
 ## License
 

diff --git a/packages/configuration/README.md b/packages/configuration/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/configuration --save
 
 ## Documentation
 
-Refer to the [Feathers configuration API documentation](https://docs.feathersjs.com/api/configuration.html) for more details.
+Refer to the [Feathers configuration API documentation](https://feathersjs.com/api/configuration.html) for more details.
 
 ## License
 

diff --git a/packages/create-feathers/README.md b/packages/create-feathers/README.md
@@ -0,0 +1,23 @@
+# create-feathers
+
+[![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
+[![Download Status](https://img.shields.io/npm/dm/@feathersjs/configuration.svg?style=flat-square)](https://www.npmjs.com/package/create-feathers)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
+
+> Generate a Feathers application through the CLI
+
+## Usage
+
+```
+npm create feathers my-app
+```
+
+## Documentation
+
+Refer to the [Feathers guides](https://feathersjs.com/guides/) for more details.
+
+## License
+
+Copyright (c) 2023 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
+
+Licensed under the [MIT license](LICENSE).
diff --git a/packages/errors/README.md b/packages/errors/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/errors --save
 
 ## Documentation
 
-Refer to the [Feathers errors API documentation](https://docs.feathersjs.com/api/errors.html) for more details.
+Refer to the [Feathers errors API documentation](https://feathersjs.com/api/errors.html) for more details.
 
 ## License
 

diff --git a/packages/express/README.md b/packages/express/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/client --save
 
 ## Documentation
 
-Refer to the [Feathers Express API documentation](https://docs.feathersjs.com/api/express.html) for more details.
+Refer to the [Feathers Express API documentation](https://feathersjs.com/api/express.html) for more details.
 
 ## License
 

diff --git a/packages/feathers/README.md b/packages/feathers/README.md
@@ -17,16 +17,14 @@ Feathers can interact with any backend technology, supports many databases out o
 You can build your first real-time and REST API in just 4 commands:
 
 ```bash
-$ npm init feathers my-new-app
+$ npm create feathers my-new-app
 $ cd my-new-app
 $ npm start
 ```
 
-To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://docs.feathersjs.com/guides).
-
 ## Documentation
 
-The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
+To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://feathersjs.com/guides).
 
 ## License
 

diff --git a/packages/generators/README.md b/packages/generators/README.md
@@ -13,7 +13,7 @@ npm install @feathersjs/generators --save-dev
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers CLI guide](https://feathersjs.com/guides/cli/) for more details.
 
 ## License
 

diff --git a/packages/knex/README.md b/packages/knex/README.md
@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/mongodb.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/mongodb)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
 > Feathers SQL service adapter using KnexJS
 
@@ -13,7 +14,7 @@ npm install @feathersjs/knex --save
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers Knex adapter documentation](https://feathersjs.com/api/databases/knex.html) for more details.
 
 ## License
 

diff --git a/packages/koa/README.md b/packages/koa/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/koa --save
 
 ## Documentation
 
-Refer to the [Feathers Koa API documentation](https://docs.feathersjs.com/api/koa.html) for more details.
+Refer to the [Feathers Koa API documentation](https://feathersjs.com/api/koa.html) for more details.
 
 ## License
 

diff --git a/packages/memory/README.md b/packages/memory/README.md
@@ -4,17 +4,17 @@
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/memory.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/memory)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
-A [Feathers](https://feathersjs.com) service adapter for in-memory data storage that works on all platforms.
+> A Feathers service adapter for in-memory data storage that works on all platforms.
+
+## Installation
 
 ```bash
 $ npm install --save @feathersjs/memory
 ```
 
-> **Important:** `@feathersjs/memory` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
-
 ## Documentation
 
-See [FeathersJS Docs - Memory Adapter](https://feathersjs.com/api/databases/memory.html).
+See [FeathersJS Memory Adapter API documentation](https://feathersjs.com/api/databases/memory.html) for more details.
 
 ## License
 

diff --git a/packages/mongodb/README.md b/packages/mongodb/README.md
@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/mongodb.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/mongodb)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
 > Feathers MongoDB service adapter
 
@@ -13,7 +14,7 @@ npm install @feathersjs/mongodb --save
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers MongoDB adapter documentation](https://feathersjs.com/api/databases/mongodb.html) for more details.
 
 ## License
 

diff --git a/packages/rest-client/README.md b/packages/rest-client/README.md
@@ -4,7 +4,7 @@
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/rest-client.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/rest-client)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
-> REST client services for different Ajax libraries
+> REST client services for different HTTP libraries
 
 ## Installation
 
@@ -14,7 +14,7 @@ npm install @feathersjs/rest-client --save
 
 ## Documentation
 
-Refer to the [Feathers REST client API documentation](https://docs.feathersjs.com/api/client/rest.html) for more details.
+Refer to the [Feathers REST client API documentation](https://feathersjs.com/api/client/rest.html) for more details.
 
 ## License
 

diff --git a/packages/schema/README.md b/packages/schema/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/schema --save
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers schema API documentation](https://feathersjs.com/api/schema/) for more details.
 
 ## License
 

diff --git a/packages/socketio-client/README.md b/packages/socketio-client/README.md
@@ -4,7 +4,7 @@
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/socketio-client.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/socketio-client)
 [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
-> The client for Socket.io Feathers connections
+> Client for Socket.io Feathers connections
 
 ## Installation
 
@@ -14,7 +14,7 @@ npm install @feathersjs/socketio-client --save
 
 ## Documentation
 
-Refer to the [Feathers SocketIO API documentation](https://docs.feathersjs.com/api/client/socketio.html) for more details.
+Refer to the [Feathers SocketIO API documentation](https://feathersjs.com/api/client/socketio.html) for more details.
 
 ## License
 

diff --git a/packages/socketio/README.md b/packages/socketio/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/socketio --save
 
 ## Documentation
 
-Refer to the [Feathers SocketIO API documentation](https://docs.feathersjs.com/api/socketio.html) for more details.
+Refer to the [Feathers SocketIO API documentation](https://feathersjs.com/api/socketio.html) for more details.
 
 ## License
 

diff --git a/packages/typebox/README.md b/packages/typebox/README.md
@@ -14,7 +14,7 @@ npm install @feathersjs/typebox --save
 
 ## Documentation
 
-Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+Refer to the [Feathers TypeBox documentation](https://feathersjs.com/api/schema/typebox.html) for more details.
 
 ## License