|
1 |
| - |
| 1 | + |
2 | 2 |
|
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 |
4 | 6 |
|
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. |
6 | 8 |
|
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 |
8 | 10 |
|
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). |
10 | 12 |
|
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. |
12 | 14 |
|
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 |
82 | 16 |
|
| 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