Skip to content

Commit

Permalink
fix: 🐛 Removes old README section
Browse files Browse the repository at this point in the history
  • Loading branch information
aviemet committed Feb 22, 2023
1 parent dd230ac commit d9b6ecc
Showing 1 changed file with 0 additions and 102 deletions.
102 changes: 0 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,6 @@ The form data ojbect would look as such:
When using the `Form` component, the `NestedFields` component becomes available as well. This makes it easy to add nested data which can then optionally be transformed before being submitted to the server. By default, Rails controllers want nested data to have '_attributes' appended to the key, which is also the default for `NestedFields` input data. This can be changed through the `renameNestedAttributes` prop which either accepts `false` to disable attribute renaming, or a function in the form `(attribute: string) => string`.
```javascript
const user = {
user: {
Expand Down Expand Up @@ -218,7 +217,6 @@ const PageWithFormOnIt = ({ user }) => {

```
With the default Rails behavior of transforming nested attribute names, the server would recieve this data in the following form:
```javascript
Expand All @@ -234,103 +232,3 @@ With the default Rails behavior of transforming nested attribute names, the serv
}
}
```
## Want to publish your Custom Hook to npm?
### 1. Set a secret in an environment variable
The authentication token/credentials have to be made available in the CI service via environment variables. For more information, see "[Authentication for plugins](https://semantic-release.gitbook.io/semantic-release/usage/ci-configuration#authentication-for-plugins)".
### 2. Create Release workflow
```yml
# .github/workflows/release.yml
name: Release
on:
push:
branches:
- "[0-9]+.x"
- "[0-9]+.[0-9]+.x"
- master
- next
- next-major
- beta
- alpha
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v1
with:
node-version: 12.x
- name: Install dependencies
run: npm ci
- name: Lint
run: |
npm run lint:types
npm run lint
- name: Test
run: npm test
env:
CI: true
- name: Build
run: npm run build
- name: Release
run: npm run release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```
### 3. Push a new commit to a `master` branch
```bash
npm run cz
git push origin master
```
## Contributing
Contributions are always welcome! Please read the [contributing](./CONTRIBUTING.md) first.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center">
<a href="https://qiita.com/kotarella1110">
<img src="https://avatars1.githubusercontent.com/u/12913947?v=4" width="100px;" alt=""/><br />
<sub><b>Kotaro Sugawara</b></sub>
</a>
<br />
<a href="https://github.com/kotarella1110/typescript-react-hooks-starter/commits?author=kotarella1110" title="Code">💻</a>
<a href="https://github.com/kotarella1110/typescript-react-hooks-starter/commits?author=kotarella1110" title="Documentation">📖</a>
<a href="#ideas-kotarella1110" title="Ideas, Planning, & Feedback">🤔</a>
<a href="#infra-kotarella1110" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a>
<a href="https://github.com/kotarella1110/typescript-react-hooks-starter/commits?author=kotarella1110" title="Tests">⚠️</a>
</td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## License
[MIT](./LICENSE) © [Kotaro Sugawara](https://twitter.com/kotarella1110)

0 comments on commit d9b6ecc

Please sign in to comment.