algolia-uploader 0.0.5 → 0.0.11

package/README.md

@@ -107,22 +107,30 @@ or
 
 ## Development
 
-### Devcontainer
+A `devcontainer` is included.
 
-`Devcontainer` is included. If you are using vscode as your editor, the command below is required only the first time it is started.
+In this repository, `.env` and `.env.ci` are encrypted with [dotenvx](https://dotenvx.com/docs/quickstart).
 
-```
-yarn dlx @yarnpkg/sdks vscode
-```
+- `.env` is for debugging and testing in your local environment
+- `.env.ci` is for testing with GitHub Actions
+  - These files contain only dummy data
+
+### How to debug
+
+Run `npm run dev`.
+
+You can debug with your real Algolia application using `.debug/example.json` or a JSON file you prepared.
+
+If you want to do so, you also need to edit the `.env` file.
 
-- Also check here :point_right: : https://yarnpkg.com/getting-started/editor-sdks
+### How to test
 
-### How to dev in your env
+Run `npm test`.
 
-You can debug in the development environment with the `yarn dev` command.
+The tests attempt to read the local `.env` file, but the actual variables used in the tests are updated internally.
 
-Running the `yarn dev` command will read the `.env` file in the development environment and access the DB provided in Algolia.
+Therefore, the tests do not access your real Algolia application.
 
-Therefore, please prepare your own Algolia test application using `.debug/example.json` and prepare the `.env` file as well.
+### GitHub Actions
 
-Also, this package uses [dotenvx](https://dotenvx.com/docs/quickstart). If you are not familiar with it, I suggest you check the original docs.
+Testing with GitHub Actions uses `.env.ci`.