Skip to content

Commit 6b46f9c

Browse files
committed
chore: update root README
1 parent 79c0ab1 commit 6b46f9c

File tree

3 files changed

+38
-130
lines changed

3 files changed

+38
-130
lines changed

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
Thank you for considering contributing to the Polywrap CLI! We welcome contributions from the community to help improve and enhance the project. Look through this repository's [issues](https://github.com/polywrap/cli/issues) to see what we're focused on solving.
3+
4+
## Pre-Requisites
5+
To be able to fully build and test all functionality within the CLI, you'll need the following programs installed:
6+
`nvm`
7+
`node`
8+
`yarn`
9+
`docker`
10+
`docker-compose`
11+
`cue`
12+
13+
## Installation
14+
15+
From the root directory, run `nvm install && nvm use` to install the correct version of Node.JS. Next, run `yarn` to install all dependencies for all packages.
16+
17+
## Build
18+
19+
Running `yarn build` from the root directory will build all packages. After this, if you'd like to rebuild an individual package you're making changes to, simply run `yarn build` within the specific `./packages/...` folder you're working in.
20+
21+
## Testing
22+
23+
Run `yarn test` from the root to test everything, and `yarn test` within a specific package folder to test just that package.
24+
25+
## Feedback and Discussions
26+
For questions, suggestions, or discussions, open an issue or create a discussion within the [Polywrap Discord](https://discord.polywrap.io).
27+
28+
Happy coding!

DEV_GUIDELINES.md

-55
This file was deleted.

README.md

+10-75
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,17 @@
1-
![Public Release Announcement](https://user-images.githubusercontent.com/5522128/177473887-2689cf25-7937-4620-8ca5-17620729a65d.png)
1+
![polywrap-banner](https://raw.githubusercontent.com/polywrap/branding/master/assets/banner.png)
22

3-
[**Polywrap**](https://polywrap.io/) is a developer tool that enables easy integration of Web3 protocols into any application. It makes it possible for applications on any platform, written in any language, to read and write data to Web3 protocols.
3+
**Polywrap** is a framework for developing software powered by Wraps. Wraps are software modules that are:
4+
* **Portable** - run in any environment
5+
* **Composable** - easily and safely call into one another
46

5-
# Getting Started
7+
We believe that the future of software will be driven by a multitude of highly-specialized, platform-agnostic modules rather than monoliths.
68

7-
Have questions or want to get involved? Join our community [Discord](https://discord.polywrap.io) or [open an issue](https://github.com/polywrap/monorepo/issues) on Github.
9+
## Getting Started
810

9-
For detailed information about Polywrap and the WRAP standard, visit our [developer documentation](https://docs.polywrap.io/).
11+
To get started using the Polywrap CLI, follow the [installation instructions](./packages/cli//README.md#installation).
1012

11-
# Contributing
13+
If you haven't already, checkout Polywrap's [developer documentation](https://docs.polywrap.io), where you'll find quick-starts & in-depth tutorials to help you accomplish your goals.
1214

13-
The Polywrap project is completely open-source and we welcome contributors of all levels.
14-
15-
Come visit our [Github issues](https://github.com/polywrap/monorepo/issues) to see the problems we're focused on solving. Here are some of our tags for issues and what they mean:
16-
17-
- `good first issue` - These are good first issues for newcomers to learn about how our project works
18-
19-
- `pri-0`, `pri-1` and `pri-2` - These are our priority issues, with `pri-0` being our highest priority and `pri-2` being lower.
20-
21-
- `alpha-blocker` - We're in pre-alpha right now and to get to alpha, we need to resolve all alpha blocker issues
22-
23-
- `beta-blocker` - After our alpha release, we'll start working towards releasing our beta! These are the blockers for us in reaching that milestone.
24-
25-
Below are a series of steps to get started with our monorepo after you've cloned it into your local repository.
26-
27-
Before contributing to this repository, please read the [developer guidelines](DEV_GUIDELINES.md).
28-
29-
## Pre-reqs
30-
31-
You'll need the following installed before building your wrapper:
32-
33-
`nvm`
34-
35-
`yarn`
36-
37-
`docker`
38-
39-
`docker-compose`
40-
41-
## Installation
42-
43-
To ensure all of your project's dependencies are installed, from inside your project's directory, simply run:
44-
45-
```
46-
nvm install && nvm use
47-
yarn
48-
```
49-
50-
## Build
51-
52-
Run the following to compile the monorepo:
53-
54-
`yarn build`
55-
56-
## Test
57-
58-
Run the following to test if the build worked:
59-
60-
```
61-
yarn test
62-
```
63-
64-
## Lint
65-
66-
To lint your project directory, run the following:
67-
68-
```
69-
yarn lint
70-
```
71-
72-
To auto-fix lint errors:
73-
74-
```
75-
yarn lint:fix
76-
```
77-
78-
# Resources
79-
- [Website](https://polywrap.io/)
80-
- [Documentation](https://docs.polywrap.io/)
81-
- [Forum](https://forum.polywrap.io/)
15+
## Contributing
8216

17+
If you're interested in contributing to this, or any Polywrap repository, checkout the [contributing guide](./CONTRIBUTING.md) as well as [join our Discord](https://discord.polywrap.io)!

0 commit comments

Comments
 (0)