From d9b6ecc50bda0e8e146b7477d15be9152fd09beb Mon Sep 17 00:00:00 2001 From: Avram Walden Date: Wed, 22 Feb 2023 12:53:59 -0800 Subject: [PATCH] =?UTF-8?q?fix:=20=F0=9F=90=9B=20Removes=20old=20README=20?= =?UTF-8?q?section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 102 ------------------------------------------------------ 1 file changed, 102 deletions(-) diff --git a/README.md b/README.md index 2458f25..bcfc3c1 100644 --- a/README.md +++ b/README.md @@ -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: { @@ -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 @@ -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)): - - - - - - - -
- -
- Kotaro Sugawara -
-
- 💻 - 📖 - 🤔 - 🚇 - ⚠️ -
- - - - - -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)