diff --git a/README.md b/README.md new file mode 100644 index 0000000..16d4d68 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# MetaCall Protocol Repository + +This repository contains the protocol implementation for MetaCall, a powerful technology enabling seamless integration of programming languages. Below is an overview of the key components and recent updates to the repository. + +## Table of Contents + +- [MetaCall Protocol](#metacall-protocol) +- [Documentation](#documentation) +- [Recent Updates](#recent-updates) +- [Testing](#testing) +- [Contributing](#contributing) +- [License](#license) + +## MetaCall Protocol + +The MetaCall Protocol is a fundamental part of the MetaCall technology, facilitating communication between different programming languages. It plays a crucial role in enabling interoperability and smooth integration in various applications. + +## Documentation + +Explore the detailed documentation for the MetaCall Protocol in the [doc](doc) directory. It provides comprehensive information on the protocol, its implementation details, and best practices for integration. + + +## Core (https://github.com/metacall/core) + +The ultimate polyglot programming experience. + +## Deploy(https://github.com/metacall/deploy) + +Tool for deploying into MetaCall FaaS platform. + +## Examples(https://github.com/metacall/examples) + +A collection of use cases and examples to be deployed in MetaCall. + +## FaaS(https://github.com/metacall/faas) + +The FaaS platform for MetaCall. + +## Testing + +The [test](test) directory contains various tests for the MetaCall Protocol. These tests are designed to ensure the reliability and correctness of the protocol implementation. If you encounter any issues or inconsistencies, please report them by opening an [issue](https://github.com/metacall/protocol-repo/issues). + +## Contributing + +We welcome contributions from the community. If you have ideas, suggestions, or want to report a bug, please feel free to open an [issue](https://github.com/metacall/protocol-repo/issues) or submit a [pull request](https://github.com/metacall/protocol-repo/pulls). +## License + +This repository is licensed under the [Apache License, Version 2.0](LICENSE). Feel free to use, modify, and distribute the code in accordance with the terms specified in the license.