Skip to content

Commit

Permalink
docs: update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
alimd committed Sep 24, 2024
1 parent 8a10663 commit b7a5097
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 24 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,16 @@ Alwatr Flux empowers your applications with elegant and powerful state managemen

Refer to the individual package READMEs for comprehensive usage instructions and examples.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please consult the CONTRIBUTING guidelines for detailed information on how to get involved.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

[MIT](./LICENSE)
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,16 @@ userContext.expire();

* **`untilChange()`:** Returns a Promise that resolves with the next context value after a change occurs.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/fetch-state-machine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,16 @@ jsonFetcher.subscribe(({state}) => {
* Concrete implementation for fetching and parsing JSON data.
* Provides access to `state`, `jsonResponse`, and `rawResponse`.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/flux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,16 @@ Alwatr Flux empowers your applications with elegant and powerful state managemen

Refer to the individual package READMEs for comprehensive usage instructions and examples.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please consult the CONTRIBUTING guidelines for detailed information on how to get involved.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

[MIT](./LICENSE)
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/fsm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,16 @@ class MyStateMachine extends FluxStateMachineBase<MyState, MyEvent> {

* **`resetToInitialState_()`:** Resets the machine to its initial state without notifying subscribers.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/observable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,16 @@ npm install @alwatr/observable
* **`clearMessage_()`:** Clears the current message without notifying subscribers.
* **`untilNewNotify_()`:** Returns a Promise that resolves with the next emitted event.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/remote-context/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,16 @@ myContext.subscribe(({state, context}) => {
* Provides access to `state` and `context`.
* Handles offline checks, automatic revalidation, and state transitions.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.
12 changes: 9 additions & 3 deletions packages/signal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,16 @@ subscription.unsubscribe();

* **`untilNewNotify()`:** Returns a Promise that resolves with the next emitted event.

## Contributing
## Sponsors

The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.
[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
This project is licensed under the AGPL-3.0 License.

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

0 comments on commit b7a5097

Please sign in to comment.