From b3badf76455f0941112843601df97c651d50e351 Mon Sep 17 00:00:00 2001 From: Alan Velasco Date: Tue, 25 Jun 2019 19:30:22 -0700 Subject: [PATCH] Removing files that are not needed --- CONTRIBUTING.md | 68 ---- FOLDERS.md | 21 - README.md | 364 ----------------- bower.json | 27 -- component.json | 25 -- package.json | 46 --- yarn.lock | 1034 ----------------------------------------------- 7 files changed, 1585 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 FOLDERS.md delete mode 100644 README.md delete mode 100644 bower.json delete mode 100644 component.json delete mode 100644 package.json delete mode 100644 yarn.lock diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ddc1d075..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,68 +0,0 @@ -# Contributing Guidelines - -Looking to contribute something? Here's how you can help. - -## Bugs reports - -A bug is a _demonstrable problem_ that is caused by the code in the -repository. Good bug reports are extremely helpful - thank you! - -Guidelines for bug reports: - -1. **Use the GitHub issue search** — check if the issue has already been - reported. - -2. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` or development branch in the repository. - -3. **Isolate the problem** — ideally create a reduced test - case and a live example. - -4. Please try to be as detailed as possible in your report. Include specific - information about the environment - operating system and version, browser - and version... and steps required to reproduce the issue. - -## Feature requests & contribution enquiries - -Feature requests are welcome. But take a moment to find out whether your idea -fits with the scope and aims of the project. It's up to *you* to make a strong -case for the inclusion of your feature. Please provide as much detail and -context as possible. - -Contribution enquiries should take place before any significant pull request, -otherwise you risk spending a lot of time working on something that we might -have good reasons for rejecting. - -## Pull requests - -Good pull requests - patches, improvements, new features - are a fantastic -help. They should remain focused in scope and avoid containing unrelated -commits. - -Make sure to adhere to the coding conventions used throughout the codebase -(indentation, accurate comments, etc.) and any other requirements (such as test -coverage). - -Please follow this process; it's the best way to get your work included in the -project: - -1. Create a new topic branch to contain your feature, change, or fix: - -2. Commit your changes in logical chunks. Provide clear and explanatory commit - messages. Use git's [interactive rebase](https://help.github.com/en/articles/about-git-rebase) - feature to tidy up your commits before making them public. - -3. Locally merge (or rebase) the upstream development branch into your topic branch: - -4. Push your topic branch up to your fork: - -5. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a - clear title and description. - -## License - -By contributing your code: - -You agree to license your contribution under the terms of the MIT (for code) and CC-BY (for graphics) licenses -https://github.com/twitter/twemoji/blob/gh-pages/LICENSE -https://github.com/twitter/twemoji/blob/gh-pages/LICENSE-GRAPHICS diff --git a/FOLDERS.md b/FOLDERS.md deleted file mode 100644 index 4afdec8a..00000000 --- a/FOLDERS.md +++ /dev/null @@ -1,21 +0,0 @@ - -| Top level | Second | Files | Description | Version | -|-----------|--------|-------|-------------|---------| -| . | | *.md, *.json, .* | meta data | 1.0, 2.2 | -| . | | twemoji*.js, *.js, [*.html](https://twitter.github.io/twemoji/) | framework, preview | 1.0 | -| 1/ | | twemoji*.js | | 1.0 | -| 1/ | templates/ | preview*.html | source for ../test/, used by ../utils/preview | 1.0 | -| 1/ | test/ | preview*.html | [static image preview HTML files](https://twitter.github.io/twemoji/1/test/preview.html) | 1.0 | -| 1/ | utils/ | *. | shell scripts | 1.0 | -| 2/ | | twemoji*.js | framework | 2.2 | -| 2/ | templates/ | preview*.html | source for ../test/, used by ../utils/preview | 2 .2| -| 2/ | test/ | preview*.html, index.html, test.js | [static image preview HTML files](https://twitter.github.io/twemoji/2/test/preview.html), ... | 2.2 | -| 2/ | utils/ | *. | shell scripts | 2.2 | -| 2/ | 72x72/ | {codepoint}.png | large PNGs | 2.2 | -| 2/ | assets/ | {codepoint}.ai | Adobe Illustrator sources | 2.2 | -| 2/ | svg/ | {codepoint}.svg | SVGs | 2.2 | -| 16x16/ | | {codepoint}.png | small PNGs | 1.0 | -| 36x36/ | | {codepoint}.png | medium PNGs | 1.0 | -| 72x72/ | | {codepoint}.png | large PNGs | 1.0 | -| assets/ | | {codepoint}.ai | Adobe Illustrator sources | 1.0 | -| svg/ | | {codepoint}.svg | SVGs | 1.0 | diff --git a/README.md b/README.md deleted file mode 100644 index 204cfac3..00000000 --- a/README.md +++ /dev/null @@ -1,364 +0,0 @@ -# Twitter Emoji (Twemoji) [![Build Status](https://travis-ci.org/twitter/twemoji.svg?branch=gh-pages)](https://travis-ci.org/twitter/twemoji) - -A simple library that provides standard Unicode [emoji](http://en.wikipedia.org/wiki/Emoji) support across all platforms. - -**Twemoji v12.0** adheres to the [Unicode 12.0 spec](https://unicode.org/versions/Unicode12.0.0/) and supports the [Emoji 12.0 spec](https://www.unicode.org/reports/tr51/tr51-16.html) - -The Twemoji library offers support for **3,075** emojis. - -#### Please note -The files in the root folder in this project are deprecated and listed for CDN and historical reasons. - -Please use the files for the current version (2) instead, located under the folder `./2/`. - -## CDN Support - -The folks over at [MaxCDN](https://www.maxcdn.com) have graciously provided CDN support. - -Use the following in the `` tag of your HTML document(s): -```html - -``` - -## Breaking changes in V2 - -_TL;DR_: there's no `variant` anymore, all callbacks receive the transformed `iconId` and in some cases the rawText too. - -There are a few potentially breaking changes in `twemoji` version 2: - - * the `parse` invoked function signature is now `(iconId, options)` instead of `(icon, options, variant)` - * the `attributes` function now receives `(rawText, iconId)` instead of `(icon, variant)` - * the **default** remote protocol is now **https** regardless of whether the current site is _http_ or even _file_ - * the **default** PNG icon size is **72** pixels and **there are no other PNG assets** for 16 or 32. - * in order to access latest assets you need to specify *folder* `2/72x72` or `2/svg`. - -Everything else is pretty much the same, so if you were using the defaults, all you need to do is to add the version `2/` before the `twemoji.js` file you were using. - - -## API - -Following are all the methods exposed in the `twemoji` namespace. - -### twemoji.parse( ... ) V1 - -This is the main parsing utility and has 3 overloads per parsing type. - -There are mainly two kinds of parsing: [string parsing](https://github.com/twitter/twemoji#string-parsing) and [DOM parsing](https://github.com/twitter/twemoji#dom-parsing). - -Each of them accepts a callback to generate an image source or an options object with parsing info. - -Here is a walkthrough of all parsing possibilities: - -##### string parsing (V1) -Given a generic string, replaces all emoji with an `` tag. - -While this can be used to inject emoji via image tags in `innerHTML`, please note that this method does not sanitize the string or prevent malicious code from being executed. As an example, if the text contains a `