Skip to content

Commit

Permalink
Update documentation to match new pugin project structure
Browse files Browse the repository at this point in the history
Also added new documentation assets like screenshots, removed outdated
ones and added new install instructions.

GH-43
  • Loading branch information
arcticicestudio committed Apr 22, 2019
1 parent 6d262a2 commit 4b0b84d
Show file tree
Hide file tree
Showing 38 changed files with 59 additions and 71 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-jetbrains-editor/develop/src/assets/nord-jetbrains-editor-banner.svg"/></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/assets/nord-jetbrains-editor-banner.svg?sanitize=true"/></p>

<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-jetbrains-editor/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-jetbrains-editor.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-v0.2.0-88C0D0.svg?style=flat-square"/></a> <img src="https://jetbrains.com/_assets/shared/favicons/jetbrains.ico" width=24 height=24/> <a href="https://www.jetbrains.com/idea/"><img src="https://img.shields.io/badge/IntelliJ_IDEA-2017.1_+-000000.svg?style=flat-square"/></a></p>
<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-jetbrains-editor/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-jetbrains-editor.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-v0.2.0-88C0D0.svg?style=flat-square"/></a> <img src="https://jetbrains.com/_assets/shared/favicons/jetbrains.ico" width=24 height=24/> <a href="https://www.jetbrains.com/idea"><img src="https://img.shields.io/badge/IntelliJ_IDEA-2019.1_+-000000.svg?style=flat-square"/></a></p>

<!--lint disable no-duplicate-headings-->

Expand All @@ -17,9 +17,9 @@ JetBrains announced a new feature for the platform that allows to [export editor

This feature greatly improves the installation process for Nord regarding the UX and version update handling compared to the manual installation and is the recommended method.

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/src/assets/scrot-installation-plugin-browse-repositories.png" /></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/assets/scrot-installation-plugin-browse-repositories.png" /></p>

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/src/assets/scrot-installation-plugin-search.png" /></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/assets/scrot-installation-plugin-search.png" /></p>

### Syntax

Expand Down Expand Up @@ -128,7 +128,7 @@ Detailed information about [features](https://github.com/arcticicestudio/nord-je

All styles have been optimized to achieve a consistent and uniform coloring across languages.

![](https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/src/assets/scrot-lang-java.png)
![](https://raw.githubusercontent.com/arcticicestudio/nord-jetbrains-editor/develop/assets/scrot-lang-java.png)

<!--
+------------------+
Expand Down
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
MIT License (MIT)

Copyright (c) 2016-present Arctic Ice Studio <[email protected]> (http://arcticicestudio.com)
Copyright (c) 2016-present Sven Greb <code@svengreb.de> (http://svengreb.de)
Copyright (C) 2016-present Arctic Ice Studio <[email protected]> (https://www.arcticicestudio.com)
Copyright (C) 2016-present Sven Greb <development@svengreb.de> (https://www.svengreb.de)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
116 changes: 52 additions & 64 deletions README.md

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes
Binary file added assets/readme-activated-state.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-activation-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-activation-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-installation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-component-test-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-component-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-context-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-import-wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-notifications.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-search-all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/readme-ui-welcome-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Diff not rendered.
Binary file removed src/assets/scrot-installation-plugin-search.png
Diff not rendered.
Binary file removed src/assets/scrot-readme-activation.png
Diff not rendered.
Binary file removed src/assets/scrot-readme-import.png
Diff not rendered.

0 comments on commit 4b0b84d

Please sign in to comment.