Skip to content

Commit

Permalink
chore: add README.md to packages (#427)
Browse files Browse the repository at this point in the history
* Initial readme file

* Add link

* Add readme
  • Loading branch information
sebastijankuzner authored Feb 16, 2024
1 parent fec5707 commit e6dcd14
Show file tree
Hide file tree
Showing 72 changed files with 1,368 additions and 0 deletions.
19 changes: 19 additions & 0 deletions packages/api-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Common

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api-database/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Database

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api-development/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Development

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api-http/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Http

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api-sync/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Sync

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api-transaction-pool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API Transaction pool

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - API

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Bootstrap

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - CLI

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/configuration-generator/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Configuration generator

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/consensus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Consensus

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/container/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Container

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/contracts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Contracts

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Core

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-address-base58/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto address Base58

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-address-bech32/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto address Beach32

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-address-bech32m/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto address Beach32m

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-address-keccak256/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto address Keccak256

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-address-ss58/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto address SS58

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
19 changes: 19 additions & 0 deletions packages/crypto-block/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mainsail - Crypto block

![banner](https://raw.githubusercontent.com/ArkEcosystem/mainsail/main/banner.png)

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://ark.dev/docs/mainsail).

## Security

If you discover a security vulnerability within this package, please send an e-mail to [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## Credits

This project exists thanks to all the people who [contribute](https://github.com/ArkEcosystem/mainsail/graphs/contributors).

## License

[GPL-3.0-only](https://github.com/ArkEcosystem/mainsail/blob/main/LICENSE) © [ARK Ecosystem](https://ark.io)
Loading

0 comments on commit e6dcd14

Please sign in to comment.