Skip to content

Commit d3b5ac2

Browse files
michaelyalimichaelyali
committed
docs(readme): updated readmes
1 parent f1e97a7 commit d3b5ac2

File tree

9 files changed

+48
-125
lines changed

9 files changed

+48
-125
lines changed

‎README.md

+12-28
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858

5959
We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find `@nestjsx/crud` microframework very useful.
6060

61-
## Features
61+
## Features :fire:
6262

6363
<img align="right" src="img/crud-usage2.png" alt="CRUD usage" />
6464

@@ -80,44 +80,28 @@ We believe that everyone who's working with NestJs and building some RESTful ser
8080

8181
- :pencil2: Swagger documentation
8282

83-
## Packages
83+
## Packages :package:
8484

85-
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs]())
86-
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs]())
87-
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs]())
85+
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))
86+
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))
87+
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs](https://github.com/nestjsx/crud/wiki/Requests#frontend-usage))
8888

89-
## Documentation
89+
## Documentation :books:
9090

91-
Use [Wiki](https://github.com/nestjsx/crud/wiki)
91+
[Wiki](https://github.com/nestjsx/crud/wiki)
9292

93-
## Roadmap
93+
## Support :raised_hands:
9494

95-
- [x] TypeORM
96-
- [ ] Mongoose
97-
- [ ] Sequelize
98-
- [ ] JSON API standard
99-
100-
## Support
101-
102-
Any support is wellcome.
95+
Any support is wellcome.
96+
You can give us a :star:, contribute or [donate](https://opencollective.com/nestjsx).
10397

10498
### Contribution
10599

106100
Please open an [issue](https://github.com/nestjsx/crud/issues) or submit a [PR](https://github.com/nestjsx/crud/pulls) if you want to improve the functionality or help with testing edge cases.
107101

108-
### Sponsorship
109-
110-
<a href="https://opencollective.com/nestjsx/donate" target="_blank">
111-
<img src="https://opencollective.com/nestjsx/donate/button@2x.png?color=blue" width=200 />
112-
</a>
113-
114-
## Tests
102+
### Backers
115103

116-
```shell
117-
docker-compose up -d
118-
yarn bootstrap
119-
yarn test
120-
```
104+
<a href="https://opencollective.com/nestjsx" target="_blank"><img src="https://opencollective.com/nestjsx/backers.svg?width=1600"></a>
121105

122106
## License
123107

‎packages/crud-request/README.md

+8-24
Original file line numberDiff line numberDiff line change
@@ -85,42 +85,26 @@ npm i @nestjsx/crud-request
8585

8686
## Packages
8787

88-
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs]())
89-
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs]())
90-
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs]())
88+
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))
89+
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))
90+
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs](https://github.com/nestjsx/crud/wiki/Requests#frontend-usage))
9191

9292
## Documentation
9393

94-
Use [Wiki](https://github.com/nestjsx/crud/wiki)
95-
96-
## Roadmap
97-
98-
- [x] TypeORM
99-
- [ ] Mongoose
100-
- [ ] Sequelize
101-
- [ ] JSON API standard
94+
[Wiki](https://github.com/nestjsx/crud/wiki)
10295

10396
## Support
10497

105-
Any support is wellcome.
98+
Any support is wellcome.
99+
You can give us a star, contribute or [donate](https://opencollective.com/nestjsx).
106100

107101
### Contribution
108102

109103
Please open an [issue](https://github.com/nestjsx/crud/issues) or submit a [PR](https://github.com/nestjsx/crud/pulls) if you want to improve the functionality or help with testing edge cases.
110104

111-
### Sponsorship
112-
113-
<a href="https://opencollective.com/nestjsx/donate" target="_blank">
114-
<img src="https://opencollective.com/nestjsx/donate/button@2x.png?color=blue" width=200 />
115-
</a>
105+
### Backers
116106

117-
## Tests
118-
119-
```shell
120-
docker-compose up -d
121-
yarn bootstrap
122-
yarn test
123-
```
107+
<a href="https://opencollective.com/nestjsx" target="_blank"><img src="https://opencollective.com/nestjsx/backers.svg?width=1600"></a>
124108

125109
## License
126110

‎packages/crud-typeorm/README.md

+8-24
Original file line numberDiff line numberDiff line change
@@ -85,42 +85,26 @@ npm i @nestjsx/crud-typeorm @nestjs/typeorm typeorm
8585

8686
## Packages
8787

88-
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs]())
89-
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs]())
90-
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs]())
88+
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))
89+
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))
90+
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs](https://github.com/nestjsx/crud/wiki/Requests#frontend-usage))
9191

9292
## Documentation
9393

94-
Use [Wiki](https://github.com/nestjsx/crud/wiki)
95-
96-
## Roadmap
97-
98-
- [x] TypeORM
99-
- [ ] Mongoose
100-
- [ ] Sequelize
101-
- [ ] JSON API standard
94+
[Wiki](https://github.com/nestjsx/crud/wiki)
10295

10396
## Support
10497

105-
Any support is wellcome.
98+
Any support is wellcome.
99+
You can give us a star, contribute or [donate](https://opencollective.com/nestjsx).
106100

107101
### Contribution
108102

109103
Please open an [issue](https://github.com/nestjsx/crud/issues) or submit a [PR](https://github.com/nestjsx/crud/pulls) if you want to improve the functionality or help with testing edge cases.
110104

111-
### Sponsorship
112-
113-
<a href="https://opencollective.com/nestjsx/donate" target="_blank">
114-
<img src="https://opencollective.com/nestjsx/donate/button@2x.png?color=blue" width=200 />
115-
</a>
105+
### Backers
116106

117-
## Tests
118-
119-
```shell
120-
docker-compose up -d
121-
yarn bootstrap
122-
yarn test
123-
```
107+
<a href="https://opencollective.com/nestjsx" target="_blank"><img src="https://opencollective.com/nestjsx/backers.svg?width=1600"></a>
124108

125109
## License
126110

‎packages/crud/README.md

+8-24
Original file line numberDiff line numberDiff line change
@@ -85,42 +85,26 @@ npm i @nestjsx/crud class-transformer class-validator
8585

8686
## Packages
8787

88-
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs]())
89-
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs]())
90-
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs]())
88+
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))
89+
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))
90+
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs](https://github.com/nestjsx/crud/wiki/Requests#frontend-usage))
9191

9292
## Documentation
9393

94-
Use [Wiki](https://github.com/nestjsx/crud/wiki)
95-
96-
## Roadmap
97-
98-
- [x] TypeORM
99-
- [ ] Mongoose
100-
- [ ] Sequelize
101-
- [ ] JSON API standard
94+
[Wiki](https://github.com/nestjsx/crud/wiki)
10295

10396
## Support
10497

105-
Any support is wellcome.
98+
Any support is wellcome.
99+
You can give us a star, contribute or [donate](https://opencollective.com/nestjsx).
106100

107101
### Contribution
108102

109103
Please open an [issue](https://github.com/nestjsx/crud/issues) or submit a [PR](https://github.com/nestjsx/crud/pulls) if you want to improve the functionality or help with testing edge cases.
110104

111-
### Sponsorship
112-
113-
<a href="https://opencollective.com/nestjsx/donate" target="_blank">
114-
<img src="https://opencollective.com/nestjsx/donate/button@2x.png?color=blue" width=200 />
115-
</a>
105+
### Backers
116106

117-
## Tests
118-
119-
```shell
120-
docker-compose up -d
121-
yarn bootstrap
122-
yarn test
123-
```
107+
<a href="https://opencollective.com/nestjsx" target="_blank"><img src="https://opencollective.com/nestjsx/backers.svg?width=1600"></a>
124108

125109
## License
126110

‎packages/crud/lib/index.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ export * from './enums';
33
export * from './interfaces';
44
export * from './types';
55
export * from './module';
6+
export * from './interceptors';

‎packages/crud/lib/index.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/crud/lib/index.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/crud/src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ export * from './enums';
33
export * from './interfaces';
44
export * from './types';
55
export * from './module';
6+
export * from './interceptors';

‎packages/util/README.md

+8-24
Original file line numberDiff line numberDiff line change
@@ -79,42 +79,26 @@ We believe that everyone who's working with NestJs and building some RESTful ser
7979

8080
## Packages
8181

82-
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs]())
83-
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs]())
84-
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs]())
82+
- [**@nestjsx/crud**](https://www.npmjs.com/package/@nestjsx/crud) - core package which provides `@Crud()` decorator for endpoints generation, global configuration, validation, helper decorators ([docs](https://github.com/nestjsx/crud/wiki/Controllers#description))
83+
- [**@nestjsx/crud-typeorm**](https://www.npmjs.com/package/@nestjsx/crud-typeorm) - TypeORM package which provides base `TypeOrmCrudService` with methods for CRUD database operations ([docs](https://github.com/nestjsx/crud/wiki/ServiceTypeorm))
84+
- [**@nestjsx/crud-request**](https://www.npmjs.com/package/@nestjsx/crud-request) - request builder/parser package wich provides `RequestQueryBuilder` class for a frontend usage and `RequestQueryParser` that is being used internaly for handling and validating query/path params on a backend side ([docs](https://github.com/nestjsx/crud/wiki/Requests#frontend-usage))
8585

8686
## Documentation
8787

88-
Use [Wiki](https://github.com/nestjsx/crud/wiki)
89-
90-
## Roadmap
91-
92-
- [x] TypeORM
93-
- [ ] Mongoose
94-
- [ ] Sequelize
95-
- [ ] JSON API standard
88+
[Wiki](https://github.com/nestjsx/crud/wiki)
9689

9790
## Support
9891

99-
Any support is wellcome.
92+
Any support is wellcome.
93+
You can give us a star, contribute or [donate](https://opencollective.com/nestjsx).
10094

10195
### Contribution
10296

10397
Please open an [issue](https://github.com/nestjsx/crud/issues) or submit a [PR](https://github.com/nestjsx/crud/pulls) if you want to improve the functionality or help with testing edge cases.
10498

105-
### Sponsorship
106-
107-
<a href="https://opencollective.com/nestjsx/donate" target="_blank">
108-
<img src="https://opencollective.com/nestjsx/donate/button@2x.png?color=blue" width=200 />
109-
</a>
110-
111-
## Tests
99+
### Backers
112100

113-
```shell
114-
docker-compose up -d
115-
yarn bootstrap
116-
yarn test
117-
```
101+
<a href="https://opencollective.com/nestjsx" target="_blank"><img src="https://opencollective.com/nestjsx/backers.svg?width=1600"></a>
118102

119103
## License
120104

0 commit comments

Comments
 (0)