docs: readme update

[nagmo-starkware]

Pull Request type

Please check the type of change your PR introduces:

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no API changes)
• Build-related changes
• Documentation content changes
• Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this introduce a breaking change?

• Yes
• No

Other information

---

This change is 

[nagmo-starkware]

Current dependencies on/for this PR:

• main
  • PR Dvir/save tx status #888
    • PR add v0.4.0 not connected to endpoint #877
      • PR docs: readme update #916 👈
      • PR fix v3 spec based on git tag #914
      • PR connect v0.4.0 to api endpoint #881
        • PR fix(JSON-RPC): make the json schema validation fail when result is null #958
          • PR feat(JSON-RPC): add support for v0.4.0-rc3 #959

This comment was auto-generated by Graphite.

[codecov]

Codecov Report

Merging #916 (360ac6c) into main (1cfcd13) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #916      +/-   ##
==========================================
- Coverage   74.61%   74.58%   -0.04%     
==========================================
  Files          71       71              
  Lines        6111     6111              
  Branches     6111     6111              
==========================================
- Hits         4560     4558       -2     
- Misses        742      745       +3     
+ Partials      809      808       -1     

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[ShahakShama]

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @dan-starkware and @nagmo-starkware)

---

README.md line 134 at r1 (raw file):

* V0_4_0
Assuming the node is exposed at `local-host:8080` one might send requests via curl with:
`curl --location 'localhost:8080/rpc/V0_3_0' --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","id":0,"method":"starknet_blockHashAndNumber"}'`

Put this in a code block and not code line (

text

instead of text

---

README.md line 134 at r1 (raw file):

* V0_4_0
Assuming the node is exposed at `local-host:8080` one might send requests via curl with:
`curl --location 'localhost:8080/rpc/V0_3_0' --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","id":0,"method":"starknet_blockHashAndNumber"}'`

Choose a method that receives one argument and add the argument to the example

[nagmo-starkware]

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @dan-starkware and @ShahakShama)

---

README.md line 134 at r1 (raw file):

Previously, ShahakShama wrote…

Choose a method that receives one argument and add the argument to the example

I picked this on purpose. I looked for something as small as possible. my intention is not to show how to use curl or json rpc but to show the path to send requests to

[ShahakShama]

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @dan-starkware and @nagmo-starkware)

---

README.md line 134 at r1 (raw file):

Previously, nagmo-starkware wrote…

I picked this on purpose. I looked for something as small as possible. my intention is not to show how to use curl or json rpc but to show the path to send requests to

If that's your purpose, then you can just say that you can query the node at the URL localhost:8080/rpc/V0_3_0

[ShahakShama]

Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @dan-starkware and @nagmo-starkware)

---

README.md line 133 at r2 (raw file):

* V0_3_0
* V0_4_0
Assuming the node is exposed at `local-host:8080` one might send requests via curl with:

local-host -> localhost

The base branch was changed.

[dan-starkware]

README.md line 132 at r2 (raw file):

Current supported versions are:
* V0_3_0
* V0_4_0

Consider:

• Add a reference to the spec
• No patch here

Code quote:

Current supported versions are:
* V0_3_0
* V0_4_0

[dan-starkware]

Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @nagmo-starkware)

a discussion (no related file):
I think this PR should be merged only after we wire v4

---

[ShahakShama]

Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @nagmo-starkware)

[ShahakShama]

Reviewed all commit messages.
Reviewable status: 0 of 1 files reviewed, 3 unresolved discussions (waiting on @nagmo-starkware)

[nagmo-starkware]

Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @dan-starkware and @ShahakShama)

a discussion (no related file):

Previously, dan-starkware wrote…

I think this PR should be merged only after we wire v4

Done.

---

---

README.md line 134 at r1 (raw file):

Previously, ShahakShama wrote…

If that's your purpose, then you can just say that you can query the node at the URL localhost:8080/rpc/V0_3_0

I think this is a good example. if you disagree let's talk

[ShahakShama]

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @dan-starkware)

[dan-starkware]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @nagmo-starkware)

---

README.md line 136 at r5 (raw file):

See spec at: [starknet-specs repo](https://github.com/starkware-libs/starknet-specs/)  

Suggestion:

See specification at: [starknet-specs repo](https://github.com/starkware-libs/starknet-specs/).

---

README.md line 140 at r5 (raw file):

```bash
curl --location 'localhost:8080/rpc/v0_3' --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","id":0,"method":"starknet_blockHashAndNumber"}'

Consider breaking the code to multiple lines so reader won't have to scroll.

Code quote:

Assuming the node is exposed at `localhost:8080` one might send requests via curl with:
```bash
curl --location 'localhost:8080/rpc/v0_3' --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","id":0,"method":"starknet_blockHashAndNumber"}'

___
*[`README.md` line 178 at r5](https://reviewable.io/reviews/starkware-libs/papyrus/916#-NbookT6AMziXZgqNkPV:-NbookT6AMziXZgqNkPW:bt8ak6t) ([raw file](https://github.com/starkware-libs/papyrus/blob/083a4b539096bbbeb5eabfb4c58fbec0ed0d66d3/README.md#L178)):*
> ```Markdown
> ## Deployment
> We provide a helm chart for deploying the node to a kubernetes cluster.
> It is located under the deployments folder.
> ```

Consider something like, if a folder doesn't work you can use the README



_Suggestion:_
```Markdown
[deployments folder](deployments/helm)

[dan-starkware]

Reviewed 1 of 1 files at r6, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @nagmo-starkware)

[dan-starkware]

Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @nagmo-starkware)