complete readme redesign #7530

vitormmatos · 2020-09-17T00:46:08Z

updated deno description matching the official site.

deno logo added aligned to the right side of the description.

twitter badge added.

installation, getting started and contributing sections have been added

This reverts the changes introduced by PR denoland#5276, which made `deno install «script»` automatically bundle the script's dependencies. It broke the `deno install` command for a large number of scripts. This reverts commit 34e98fa. Closes: denoland#7492

Also re-exports deno_core::futures and deno_core::serde_json but these are not yet used in the CLI.

) Instead use Deno.core.jsonOpSync and Deno.core.jsonOpAsync

updated deno description matching the official site. deno logo added aligned to the right side of the description. twitter badge added. installation, getting started and contributing sections have been added

CLAassistant · 2020-09-17T00:46:11Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
10 out of 11 committers have signed the CLA.

✅ piscisaureus
✅ ry
✅ bartlomieju
✅ caspervonb
✅ nayeemrmn
✅ g-plane
✅ JayHelton
✅ lucacasonato
✅ tokiedokie
✅ vitormmatos
❌ Vitor Matos

Vitor Matos seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

kitsonk · 2020-09-17T03:33:02Z

It is probably a really good idea to discuss these sorts of changes with someone on the core team before you attempt to raise a PR.

ry · 2020-09-17T03:54:02Z

@kitsonk is right - but in this case I like it! Please sign the CLA and I'll land.

tokiedokie · 2020-09-17T07:11:44Z

README.md

+
+You can find a more in depth introduction, examples, and environment setup guides in the [manual](https://deno.land/manual).
+
+More in-depth info can be found in the runtime [documentation](doc.deno.land)


Suggested change

More in-depth info can be found in the runtime [documentation](doc.deno.land)

More in-depth info can be found in the [runtime documentation](https://doc.deno.land/builtin/stable)

missing url

Suggested change

More in-depth info can be found in the runtime [documentation](doc.deno.land)

More info can be found in the [runtime documentation](https://doc.deno.land/builtin/stable).

tokiedokie · 2020-09-17T07:16:23Z

README.md

+
+We appreciate your help!
+
+To contribute, please read the our [guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)


Suggested change

To contribute, please read the our [guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)

To contribute, please read the our [guidelines](https://deno.land/manual/contributing)

I think we should use deno.land/manual instead of a markdown file

Suggested change

To contribute, please read the our [guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)

To contribute, please read our [guidelines](https://deno.land/manual/contributing).

tokiedokie · 2020-09-17T07:19:15Z

README.md

+
+See [deno_install](https://github.com/denoland/deno_install/blob/master/README.md) and [releases](https://github.com/denoland/deno/releases) for other options.
+
+### Getting Started


Suggested change

### Getting Started

## Getting Started

tokiedokie · 2020-09-17T07:19:51Z

README.md


-[Install](https://github.com/denoland/deno_install)
+### Install


Suggested change

### Install

## Install

tokiedokie · 2020-09-17T07:20:09Z

README.md


-[Website](https://deno.land/)
+### Features


Suggested change

### Features

## Features

nayeemrmn · 2020-09-17T07:26:35Z

README.md

+- Supports TypeScript out of the box.
+- Ships only a single executable file.
+- Built-in utilities like a dependency inspector (deno info) and a code formatter (deno fmt).
+- Set of reviewed standard modules that are guaranteed to work with [Deno](https://deno.land/std/)


Suggested change

- Set of reviewed standard modules that are guaranteed to work with [Deno](https://deno.land/std/)

- Set of reviewed standard modules that are guaranteed to work with [Deno](https://deno.land/std/).

vitormmatos · 2020-09-17T09:18:05Z

@kitsonk is right - but in this case I like it! Please sign the CLA and I'll land.

Just signed the CLA.
I know it's not much, but I hope I can help the project, now and in the future.
About discussing with the core team for future pull requests, where can it be done?

Thanks for the support.

kitsonk · 2020-09-17T10:24:35Z

@vitormmatos two main ways, an issue stating what the problem is and the suggested approach to fix it, second would be on Discord in the #dev channel there.

)

newtack · 2020-09-17T15:09:03Z

Not sure this is the right place, but I would make the following change:

Batteries included:

Tooling: built-in Typescript compiling, testing, linting and formatting.
Standard libraries replacing need for many 3rd party libraries

For me personally, another huge value add is that with the single executable I can upgrade the equivalent of Node, Typescript, eslint, jest, prettier in one command and all integrated.

Deno really removes a lot of friction.

Moves op_close and op_resources to deno_core::ops and exports them. Adds serde dependency to deno_core and reexports it. Moves JS implementation of those ops to Deno.core and reexports them in Deno.

Restructures flag helpers and applies them consistently.

mjrlowe · 2020-09-18T17:40:39Z

README.md

+
+Or a more complex one:
+
+```sh


I think this sh should be js.

ry · 2020-09-18T17:54:48Z

@vitormmatos can you please check the CLA again - it's not green.

Skillz4Killz · 2020-09-18T19:46:44Z

If Twitter is added perhaps Discord could be added? 🤔

[![Discord](https://img.shields.io/discord/684898665143206084?color=697EC4&label=Discord&logo=discord&logoColor=FDFEFE&style=flat-square)](https://discord.gg/deno) You may need to enable the widget in discord server settings

vitormmatos · 2020-09-21T01:39:38Z

@vitormmatos can you please check the CLA again - it's not green.

Not sure what happened before, It was showing that I was signed in the CLA.
I tried it again just now and it's showing as signed.

kitsonk · 2020-09-21T01:49:14Z

@vitormmatos the e-mail you used in the commit message does not match what you have registered on your GitHub account, and therefore it cannot identify you as the author of the commit:

commit 9e7966741d9a18a90dba62f8f58aac7bf5f8b105
Author: Vitor Matos <[email protected]>
Date:   Wed Sep 16 21:40:53 2020 -0300

    complete readme redesign
    
    updated deno description matching the official site.
    
    deno logo added aligned to the right side of the description.
    
    twitter badge added.
    
    installation, getting started and contributing sections have been added

There are ways to hide your e-mail address with GitHub, under your profile settings, if you don't want it to be part of a commit message. GitHub will issue you a specific GitHub e-mail address tied to your account.

vitormmatos · 2020-09-21T02:19:12Z

@vitormmatos the e-mail you used in the commit message does not match what you have registered on your GitHub account, and therefore it cannot identify you as the author of the commit:
commit 9e7966741d9a18a90dba62f8f58aac7bf5f8b105
Author: Vitor Matos <[email protected]>
Date:   Wed Sep 16 21:40:53 2020 -0300

    complete readme redesign
    
    updated deno description matching the official site.
    
    deno logo added aligned to the right side of the description.
    
    twitter badge added.
    
    installation, getting started and contributing sections have been added
There are ways to hide your e-mail address with GitHub, under your profile settings, if you don't want it to be part of a commit message. GitHub will issue you a specific GitHub e-mail address tied to your account.

I have no problem with the e-mail been shown, but how can I fix it now?
I've changed the e-mail used on global config on my machine to match the one used on Github, what shall I do next for the CLA license to be properly signed. Should I do a new commit?

Sorry for the trouble.

…into updated-readme

vitormmatos · 2020-09-21T07:24:52Z

Just now I realized something quite strange. I'm signed and not signed in the CLA. My username is vitormmatos. Sorry for the trouble guys, really. Honestly, I have no idea what's going on here, and how to fix this.

hazae41 · 2020-09-29T14:16:57Z

@vitormmatos I think you have to make a whole new branch, new commit and new PR

ry

LGTM - thanks @vitormmatos

ry and others added 9 commits September 16, 2020 12:41

simplify global properties (denoland#7502)

ab599e2

Remove unnecessary serde_derive dependency

f4376e4

Remove unnecessary extern statements

b174dff

Re-export deno_core::url (denoland#7525)

e49f9d1

Also re-exports deno_core::futures and deno_core::serde_json but these are not yet used in the CLI.

refactor: remove dispatch_json.js from cli/rt and cli/tsc (denoland#7521

4d455f2

) Instead use Deno.core.jsonOpSync and Deno.core.jsonOpAsync

test(std/wasi): add sched_yield test (denoland#7511)

75598ac

complete readme redesign

9e79667

updated deno description matching the official site. deno logo added aligned to the right side of the description. twitter badge added. installation, getting started and contributing sections have been added

complete readme redesign

e905de2

updated deno description matching the official site. deno logo added aligned to the right side of the description. twitter badge added. installation, getting started and contributing sections have been added

tokiedokie reviewed Sep 17, 2020

View reviewed changes

nayeemrmn reviewed Sep 17, 2020

View reviewed changes

ry added 2 commits September 17, 2020 16:11

refactor: make fetch use op_fetch_read instead of op_read (denoland#7529

7272a32

)

fix: Use Buffer.writeSync in MultipartBuilder (denoland#7542)

515a6f6

lucacasonato and others added 11 commits September 17, 2020 17:26

chore: remove readJson/writeJson from manual (denoland#7541)

f3365ec

refactor: disable URL.createObjectUrl (denoland#7543)

129423b

refactor: move op_resources and op_close to deno_core (denoland#7539)

376533d

Moves op_close and op_resources to deno_core::ops and exports them. Adds serde dependency to deno_core and reexports it. Moves JS implementation of those ops to Deno.core and reexports them in Deno.

refactor: use Symbol.for instead of Symbol in cli/rt/ (denoland#7537)

7a8ff3f

fix(cli/console): escape non printable characters in object entries (d…

50f3eb2

…enoland#7533)

refactor: Move URL to op_crates/web (denoland#7544)

a78e295

fix: disable rustyline logs (denoland#7535)

525012b

fix(cli/fmt): make fmt output more readable (denoland#7534)

581fd0f

feat(std/node) stub out process.stdin, stdout, stderr (denoland#7184)

37b089b

refactor: deno_fetch op crate (denoland#7524)

59cf419

fix(cli/console): always quote and escape inspected strings (denoland…

b8647ad

…#7546)

bartlomieju and others added 7 commits September 18, 2020 16:01

refactor: move FileReader to op_crates/web (denoland#7554)

c181fa7

fix(cli/console): surround non alpha-numeric object keys with quotes (d…

e5e8bcb

…enoland#7550)

publish deno_fetch during CI (denoland#7557)

e5e9ddc

fix(cli/repl): format evaluation results with the object specifier (d…

676b15d

…enoland#7561)

fix(cli/fmt): canonicalize files in current dir (denoland#7508)

9ca3879

Use reqwest from deno_fetch export (denoland#7562)

e73f95e

fix(bundle, eval, repl): Add missing flags (denoland#7414)

e38fe59

Restructures flag helpers and applies them consistently.

mjrlowe reviewed Sep 18, 2020

View reviewed changes

README.md

Or a more complex one:

```sh

Copy link

Contributor

mjrlowe Sep 18, 2020

Choose a reason for hiding this comment

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

I think this sh should be js.

ry added 4 commits September 18, 2020 13:55

Merge branch 'master' into updated-readme

b4e90d3

Merge branch 'master' into updated-readme

8c5928a

fmt

d864f0d

fmt

6c399ab

Merge branch 'updated-readme' of https://github.com/vitormmatos/deno …

13bf179

…into updated-readme

ry approved these changes Sep 29, 2020

View reviewed changes

ry merged commit 04f05d0 into denoland:master Sep 29, 2020

Soremwar pushed a commit to Soremwar/deno that referenced this pull request Oct 6, 2020

improve readme (denoland#7530)

8b60d7a

kt3k mentioned this pull request Apr 9, 2021

chore(readme): Improve link descriptions #10083

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

complete readme redesign #7530

complete readme redesign #7530

vitormmatos commented Sep 17, 2020

CLAassistant commented Sep 17, 2020 •

edited

Loading

kitsonk commented Sep 17, 2020

ry commented Sep 17, 2020

tokiedokie Sep 17, 2020

tokiedokie Sep 17, 2020

nayeemrmn Sep 17, 2020

tokiedokie Sep 17, 2020

tokiedokie Sep 17, 2020

nayeemrmn Sep 17, 2020

tokiedokie Sep 17, 2020

tokiedokie Sep 17, 2020

tokiedokie Sep 17, 2020

nayeemrmn Sep 17, 2020

vitormmatos commented Sep 17, 2020

kitsonk commented Sep 17, 2020

newtack commented Sep 17, 2020

mjrlowe Sep 18, 2020

ry commented Sep 18, 2020

Skillz4Killz commented Sep 18, 2020

vitormmatos commented Sep 21, 2020

kitsonk commented Sep 21, 2020

vitormmatos commented Sep 21, 2020

vitormmatos commented Sep 21, 2020

hazae41 commented Sep 29, 2020

ry left a comment


		You can find a more in depth introduction, examples, and environment setup guides in the [manual](https://deno.land/manual).

		More in-depth info can be found in the runtime [documentation](doc.deno.land)

	More in-depth info can be found in the runtime [documentation](doc.deno.land)
	More in-depth info can be found in the [runtime documentation](https://doc.deno.land/builtin/stable)

	More in-depth info can be found in the runtime [documentation](doc.deno.land)
	More info can be found in the [runtime documentation](https://doc.deno.land/builtin/stable).


		We appreciate your help!

		To contribute, please read the our [guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)

	To contribute, please read the our [guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)
	To contribute, please read our [guidelines](https://deno.land/manual/contributing).


		See [deno_install](https://github.com/denoland/deno_install/blob/master/README.md) and [releases](https://github.com/denoland/deno/releases) for other options.

		### Getting Started


		[Install](https://github.com/denoland/deno_install)
		### Install

	- Set of reviewed standard modules that are guaranteed to work with [Deno](https://deno.land/std/)
	- Set of reviewed standard modules that are guaranteed to work with [Deno](https://deno.land/std/).

complete readme redesign #7530

complete readme redesign #7530

Conversation

vitormmatos commented Sep 17, 2020

CLAassistant commented Sep 17, 2020 • edited Loading

kitsonk commented Sep 17, 2020

ry commented Sep 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitormmatos commented Sep 17, 2020

kitsonk commented Sep 17, 2020

newtack commented Sep 17, 2020

Choose a reason for hiding this comment

ry commented Sep 18, 2020

Skillz4Killz commented Sep 18, 2020

vitormmatos commented Sep 21, 2020

kitsonk commented Sep 21, 2020

vitormmatos commented Sep 21, 2020

vitormmatos commented Sep 21, 2020

hazae41 commented Sep 29, 2020

ry left a comment

Choose a reason for hiding this comment

CLAassistant commented Sep 17, 2020 •

edited

Loading