-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from nestdotland/dev
0.3.5
- Loading branch information
Showing
7 changed files
with
104 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,9 +5,9 @@ | |
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, gender identity and expression, level of experience, | ||
| nationality, personal appearance, race, religion, or sexual identity and | ||
| orientation. | ||
| size, disability, ethnicity, gender identity and expression, level of | ||
| experience, nationality, personal appearance, race, religion, or sexual identity | ||
| and orientation. | ||
|
|
||
| ### Our Standards | ||
|
|
||
|
|
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable | |
| behaviour and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behaviour. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned to this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
| Project maintainers have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions that are | ||
| not aligned to this Code of Conduct, or to ban temporarily or permanently any | ||
| contributor for other behaviors that they deem inappropriate, threatening, | ||
| offensive, or harmful. | ||
|
|
||
| ### Scope | ||
|
|
||
|
|
@@ -55,20 +55,20 @@ further defined and clarified by project maintainers. | |
| ### Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behaviour may be | ||
| reported by contacting the project team at [email protected]. All | ||
| complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and appropriate to the circumstances. The project team is | ||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||
| Further details of specific enforcement policies may be posted separately. | ||
| reported by contacting the project team at [email protected]. All complaints | ||
| will be reviewed and investigated and will result in a response that is deemed | ||
| necessary and appropriate to the circumstances. The project team is obligated to | ||
| maintain confidentiality with regard to the reporter of an incident. Further | ||
| details of specific enforcement policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership. | ||
|
|
||
| ### Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at [http://contributor-covenant.org/version/1/4][version] | ||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ | |
| > | ||
| </a> | ||
|
|
||
| <h3 align="center">Eggs CLI</h3> | ||
| <h3 align="center">Eggs CLI</h3> | ||
| <p align="center"> | ||
| The CLI used to publish and update modules in nest.land. | ||
| </p> | ||
|
|
@@ -55,7 +55,7 @@ | |
| **Note: You need to upgrade to Deno v1.6.0 or newer in order to use our CLI.** | ||
|
|
||
| ```shell script | ||
| deno install -Afq --unstable https://x.nest.land/[email protected].4/eggs.ts | ||
| deno install -Afq --unstable https://x.nest.land/[email protected].5/eggs.ts | ||
| ``` | ||
|
|
||
| For more information, see the [documentation](https://docs.nest.land/). | ||
|
|
@@ -73,8 +73,8 @@ Then, use `link` to add it to the CLI: | |
| eggs link <key> | ||
| ``` | ||
|
|
||
| Alternatively, you can manually create a `.nest-api-key` file at your user | ||
| home directory. | ||
| Alternatively, you can manually create a `.nest-api-key` file at your user home | ||
| directory. | ||
|
|
||
| ### Init | ||
|
|
||
|
|
@@ -85,8 +85,8 @@ project as well. To do this easily, type: | |
| eggs init | ||
| ``` | ||
|
|
||
| Note: If you'd like to specify a version that you'll publish to, you can | ||
| include a `version` variable in `egg.json`. | ||
| Note: If you'd like to specify a version that you'll publish to, you can include | ||
| a `version` variable in `egg.json`. | ||
|
|
||
| ### Publish | ||
|
|
||
|
|
@@ -97,39 +97,39 @@ your package to our registry with this command: | |
| eggs publish | ||
| ``` | ||
|
|
||
| You'll receive a link to your package on our registry, along with an import | ||
| URL for others to import your package from the Arweave blockchain! | ||
| You'll receive a link to your package on our registry, along with an import URL | ||
| for others to import your package from the Arweave blockchain! | ||
|
|
||
| Note: It may take some time for the transaction to process in Arweave. | ||
| Until then, we upload your files to our server, where they are served for | ||
| 20 minutes to give the transaction time to process. | ||
| Note: It may take some time for the transaction to process in Arweave. Until | ||
| then, we upload your files to our server, where they are served for 20 minutes | ||
| to give the transaction time to process. | ||
|
|
||
| ### Update | ||
|
|
||
| You can easily update your dependencies and global scripts with | ||
| the `update` command. | ||
| You can easily update your dependencies and global scripts with the `update` | ||
| command. | ||
|
|
||
| ```shell script | ||
| eggs update [deps] <options> | ||
| ``` | ||
|
|
||
| Your dependencies are by default checked in the `deps.ts` file | ||
| (current working directory). You can change this with `--file` | ||
| Your dependencies are by default checked in the `deps.ts` file (current working | ||
| directory). You can change this with `--file` | ||
|
|
||
| ```shell script | ||
| eggs update # default to deps.ts | ||
| eggs update --file dependencies.ts | ||
| ``` | ||
|
|
||
| In regular mode, all your dependencies are updated. You can choose which | ||
| ones will be modified by adding them as arguments. | ||
| In regular mode, all your dependencies are updated. You can choose which ones | ||
| will be modified by adding them as arguments. | ||
|
|
||
| ```shell script | ||
| eggs update # Updates everything | ||
| eggs update http fs eggs # Updates only http, fs, eggs | ||
| ``` | ||
|
|
||
| Scripts installed with `eggs install` can also be updated with the `-g` | ||
| Scripts installed with `eggs install` can also be updated with the `-g` | ||
| parameter. | ||
|
|
||
| ```shell script | ||
|
|
@@ -139,41 +139,41 @@ eggs update eggs denon -g # Updates only eggs, denon | |
|
|
||
| Several registries are supported. The current ones are: | ||
|
|
||
| * x.nest.land | ||
| * deno.land/x | ||
| * deno.land/std | ||
| * raw.githubusercontent.com | ||
| * denopkg.com | ||
| - x.nest.land | ||
| - deno.land/x | ||
| - deno.land/std | ||
| - raw.githubusercontent.com | ||
| - denopkg.com | ||
|
|
||
| If you want to add a registry, open an issue by specifying the registry | ||
| url and we'll add it. | ||
| If you want to add a registry, open an issue by specifying the registry url and | ||
| we'll add it. | ||
|
|
||
| An example of updated file: | ||
|
|
||
| ```ts | ||
| import * as colors from "https://deno.land/[email protected]/fmt/colors.ts"; | ||
| import * as bcrypt from "https://deno.land/x/[email protected]/mod.ts" | ||
| import * as eggs from "https://x.nest.land/[email protected]/mod.ts" | ||
| import * as http from "https://deno.land/std/http/mod.ts" | ||
| import * as bcrypt from "https://deno.land/x/[email protected]/mod.ts"; | ||
| import * as eggs from "https://x.nest.land/[email protected]/mod.ts"; | ||
| import * as http from "https://deno.land/std/http/mod.ts"; | ||
| ``` | ||
|
|
||
| After `eggs update`: | ||
|
|
||
| ```ts | ||
| import * as colors from "https://deno.land/[email protected]/fmt/colors.ts"; | ||
| import * as bcrypt from "https://deno.land/x/[email protected]/mod.ts" | ||
| import * as eggs from "https://x.nest.land/[email protected]/mod.ts" | ||
| import * as http from "https://deno.land/std/http/mod.ts" | ||
| import * as bcrypt from "https://deno.land/x/[email protected]/mod.ts"; | ||
| import * as eggs from "https://x.nest.land/[email protected]/mod.ts"; | ||
| import * as http from "https://deno.land/std/http/mod.ts"; | ||
| ``` | ||
|
|
||
| ### Install | ||
|
|
||
| Just like `deno install`, you can install scripts globally with eggs. | ||
| By installing it this way, you will be notified if an update is available | ||
| for your script. | ||
| Just like `deno install`, you can install scripts globally with eggs. By | ||
| installing it this way, you will be notified if an update is available for your | ||
| script. | ||
|
|
||
| The verification is smart, it can't be done more than once a day. To install | ||
| a script, simply replace `deno` with `eggs`. | ||
| The verification is smart, it can't be done more than once a day. To install a | ||
| script, simply replace `deno` with `eggs`. | ||
|
|
||
| ```shell script | ||
| deno install --allow-write --allow-read -n [NAME] https://x.nest.land/[MODULE]@[VERSION]/cli.ts | ||
|
|
@@ -198,8 +198,8 @@ eggs upgrade | |
| ## Contributing | ||
|
|
||
| All contributions are welcome! If you can think of a command or feature that | ||
| might benefit nest.land, fork this repository and make a pull request from | ||
| your branch with the additions. Make sure to use [Conventional | ||
| Commits](https://www.conventionalcommits.org/en/v1.0.0/) | ||
| might benefit nest.land, fork this repository and make a pull request from your | ||
| branch with the additions. Make sure to use | ||
| [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) | ||
|
|
||
| [Contribution guide](.github/CONTRIBUTING.md) | ||
| [Contribution guide](.github/CONTRIBUTING.md) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.