Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #317

Closed
wants to merge 1 commit into from
Closed

update readme #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ Read the whitepaper:

For additional information, press, and development inquiries, please refer to the Kadena [website](https://kadena.io)

> [!IMPORTANT]
> This repository hosts a rewrite of the Pact language and is not utilized by [chainweb-node](https://github.com/kadena-io/chainweb-node),
> serving primarily for local development and testing purposes. We detail the planned transition from Pact to Pact Core in [Section Roadmap](#roadmap).

If you are looking for legacy Pact, see [github.com/kadena-io/pact](https://github.com/kadena-io/pact).

## Table of Contents
- [Quickstart](#quickstart)
- [Pact Core vs Pact](#pact-core-vs-pact)
Expand All @@ -46,30 +40,24 @@ If you are looking for legacy Pact, see [github.com/kadena-io/pact](https://gith
```
4. Execute `pact` and have fun :-)

## Pact Core vs Pact
Pact Core is a redevelopment of the Pact language, focusing on enhancing scalability, maintainability, and performance in response to increasingly complex demands from users and partners.

Pact Core enables sustainable growth of the Pact featureset within the Kadena ecosystem by offering a more modular and maintainable internals, enabling the community to further develop and propose enhancements to the language and components that rely on it.

Pact Core maintains semantic equivalence to Pact, aside from minor differences for security and performance. Existing code will behave the same as code written in (legacy) Pact. Breaking modifications will be communicated using the [Kadena Improvement Process](https://github.com/kadena-io/kips) (KIP) process.

### Roadmap
> [!NOTE]
> The current roadmap is being sketched by the Pact Team and will be updated.
## Pact-5 vs Pact
Pact-5 (initially referred to Pact Core) is a comprehensive rewrite of the Pact language, focusing on enhancing scalability, maintainability, and performance in response to increasingly complex demands from users and partners.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Pact-5 (initially referred to Pact Core) is a comprehensive rewrite of the Pact language, focusing on enhancing scalability, maintainability, and performance in response to increasingly complex demands from users and partners.
Pact 5 (initially referred to as Pact Core) is a comprehensive rewrite of the Pact language, focusing on enhancing scalability, maintainability, and performance in response to increasingly complex demands from users and partners.

This new implementation enables sustainable growth of the Pact featureset within the Kadena ecosystem through more modular and maintainable internals, empowering the community to further develop and propose enhancements to the language and its dependent components.
Pact-5 maintains semantic equivalence to the original Pact implementation, with select modifications made to enhance security and performance. Existing code will continue to function as expected. Breaking modifications will be communicated using the [Kadena Improvement Process](https://github.com/kadena-io/kips) (KIP) process.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Pact-5 maintains semantic equivalence to the original Pact implementation, with select modifications made to enhance security and performance. Existing code will continue to function as expected. Breaking modifications will be communicated using the [Kadena Improvement Process](https://github.com/kadena-io/kips) (KIP) process.
Pact 5 maintains semantic equivalence to the original Pact implementation for the most part, with select modifications made to enhance security and performance. Existing code will mostly continue to function as expected. Breaking modifications are in <migration doc link>


## Documentation
The [Kadena Docs](https://docs.kadena.io/pact) site serves as the primary source of information about Pact.
The [Kadena Docs](https://docs.kadena.io/) site serves as the primary source of information about Pact.
You can find information about how to get started with the Pact language, how to execute already deployed contracts, and follow
our step-by-step tutorials.
our step-by-step tutorials.

We recommend that new users start with our [beginner`s guide](https://docs.kadena.io/pact/beginner), which provides an
We recommend that new users start with our [get started intro](https://docs.kadena.io/smart-contracts/get-started-intro), which provides an
understanding of the fundamental concepts and terminology of the language.

## Installing Pact Core
To install Pact Core on your infrastructure, you have the option to download a pre-built binary or compile it from the source.

### Binary Downloads
You can obtain the latest released version of Pact from our GitHub releases page [here](https://github.com/kadena-io/pact-core/releases).
You can obtain the latest released version of Pact from our GitHub releases page [here](https://github.com/kadena-io/pact-5/releases).
Ensure to download the binary that corresponds to your specific architecture.

### Building from Source
Expand Down
Loading