Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
karimdaghari committed Oct 30, 2023
1 parent 96bb2ac commit 6fb317c
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 69 deletions.
48 changes: 18 additions & 30 deletions packages/eslint/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,37 @@
# marzee-tools
# @marzee/eslint

> A set of tools commonly used at marzee
> Ready-to-use ESLint configuration for Next.js/TypeScript projects
background details relevant to understanding what this module does
`@marzee/eslint` provides a set of opinionated ESLint configurations for Next.js/TypeScript projects.

## Usage

```js
var marzeeTools = require('marzee-tools')
/** @type {import("eslint").Linter.Config} */
const config = {
extends: [
'@marzee/eslint/next',
],
};

console.log('hello warld')
```

outputs

```
hello warld
```

## API
export default config;

```js
var marzeeTools = require('marzee-tools')
```

See [api_formatting.md](api_formatting.md) for tips.

## Install

With [npm](https://npmjs.org/) installed, run

```
$ npm install marzee-tools
```sh
npm i -D @marzee/eslint
```

## Acknowledgments

marzee-tools was inspired by..

## See Also
```sh
pnpm i -D @marzee/eslint
```

- [`noffle/common-readme`](https://github.com/noffle/common-readme)
- ...
```sh
yarn add -D @marzee/eslint
```

## License

ISC

10 changes: 5 additions & 5 deletions packages/react-auth-amplify/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# react-auth-amplify
# @marzee/react-auth-amplify

> A React.js-Amplify Auth integration
`react-auth-amplify` provides a straightforward integration for email and password authentication with AWS cognito. Optionally, it integrates with Next.js.
`@marzee/react-auth-amplify` provides a straightforward integration for email and password authentication with AWS cognito. Optionally, it integrates with Next.js.

## Usage

Expand Down Expand Up @@ -144,15 +144,15 @@ The following functions are available:
## Install

```sh
npm i @marzeetools/react-auth-amplify aws-amplify@^5
npm i @marzee/react-auth-amplify aws-amplify@^5
```

```sh
pnpm i @marzeetools/react-auth-amplify aws-amplify@^5
pnpm i @marzee/react-auth-amplify aws-amplify@^5
```

```sh
yarn i @marzeetools/react-auth-amplify aws-amplify@^5
yarn i @marzee/react-auth-amplify aws-amplify@^5
```

## License
Expand Down
56 changes: 23 additions & 33 deletions packages/tsconfig/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,39 @@
# marzee-tools
# @marzee/tsconfig

> A set of tools commonly used at marzee
> A TSconfig with the latest best practices
background details relevant to understanding what this module does
`@marzee/tsconfig` provides an opinionated TSconfig with the latest best practices for both Next and Node projects.

## Usage

```js
var marzeeTools = require('marzee-tools')
### Next.js

console.log('hello warld')
```json
{
"extends": "@marzee/tsconfig/next",
// the rest of your config here
}
```

outputs
### Node

```
hello warld
```

## API

```js
var marzeeTools = require('marzee-tools')
```json
{
"extends": "@marzee/tsconfig/node",
// the rest of your config here
}
```

See [api_formatting.md](api_formatting.md) for tips.

## Install

With [npm](https://npmjs.org/) installed, run

```
$ npm install marzee-tools
```sh
npm i -D @marzee/tsconfig
```

## Acknowledgments

marzee-tools was inspired by..

## See Also

- [`noffle/common-readme`](https://github.com/noffle/common-readme)
- ...

## License

ISC
```sh
pnpm i -D @marzee/tsconfig
```

```sh
yarn add -D @marzee/tsconfig
```
2 changes: 1 addition & 1 deletion packages/tsconfig/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@marzee/tsconfig-node18",
"name": "@marzee/tsconfig",
"version": "1.0.0",
"description": "A TSconfig with the latest best practices",
"repository": {
Expand Down

0 comments on commit 6fb317c

Please sign in to comment.