8000 fix: Make sure all Readme files are up to date by daffl · Pull Request #3154 · feathersjs/feathers · GitHub
[go: up one dir, main page]

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/public/img/feathers-logo-wide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions packages/adapter-commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/authentication-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/authentication-local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/authentication-oauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/authentication/README.md
C27F
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 8 additions & 2 deletions packages/commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
23 changes: 23 additions & 0 deletions packages/create-feathers/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion packages/errors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 c C27F hanges: 1 addition & 1 deletion packages/express/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 2 additions & 4 deletions packages/feathers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

4941 ## License

Expand Down
2 changes: 1 addition & 1 deletion packages/generators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion packages/knex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/koa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions packages/memory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion packages/mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions packages/rest-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions packages/socketio-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/socketio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/typebox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
0