New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a description field to the package.json #2654

Merged
merged 1 commit into from Feb 7, 2017

Conversation

Projects
None yet
2 participants
@Haroenv
Copy link
Member

Haroenv commented Feb 7, 2017

Summary

add a description field to the package.json which is used on npmjs.com, yarnpkg.com/search and more places, right now the description will be read out of the first part of the readme, which isn't that useful:

description: '<p align="center">   <a href="https://yarnpkg.com/">     <img alt="Yarn" src="https://github.com/yarnpkg/assets/blob/master/yarn-kitten-full.png?raw=true" width="546">   </a> </p>',

The npm site renders this as html, while yarnpkg.com/search renders it as escaped text, so plain text is the best choice for this case.

I picked the description from on github to replicate here.

Test plan

There's not really code change here

add a description field to the package.json
this is used on npmjs.com, yarnpkg.com/search and more places, right now the description will be read out of the first part of the readme, which isn't that useful:

```
description: '<p align="center">   <a href="https://yarnpkg.com/">     <img alt="Yarn" src="https://github.com/yarnpkg/assets/blob/master/yarn-kitten-full.png?raw=true" width="546">   </a> </p>',
```

The npm site renders this as html, while yarnpkg.com/search renders it as escaped text, so plain text is the best choice for this case.

I picked the description from on github to replicate here.

@bestander bestander merged commit 9694eab into yarnpkg:master Feb 7, 2017

3 checks passed

ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

mnsn added a commit to mnsn/yarn that referenced this pull request Feb 15, 2017

add a description field to the package.json (yarnpkg#2654)
this is used on npmjs.com, yarnpkg.com/search and more places, right now the description will be read out of the first part of the readme, which isn't that useful:

```
description: '<p align="center">   <a href="https://yarnpkg.com/">     <img alt="Yarn" src="https://github.com/yarnpkg/assets/blob/master/yarn-kitten-full.png?raw=true" width="546">   </a> </p>',
```

The npm site renders this as html, while yarnpkg.com/search renders it as escaped text, so plain text is the best choice for this case.

I picked the description from on github to replicate here.

@Haroenv Haroenv deleted the Haroenv:package-description branch Aug 19, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment