Skip to content

Commit 5bcfb6a

Browse files
authored
docs: update readme (#7287)
1 parent 5d98702 commit 5bcfb6a

File tree

1 file changed

+7
-68
lines changed

1 file changed

+7
-68
lines changed

README.md

+7-68
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,14 @@
66
<strong>An ecosystem of developer tools that accelerate and simplify building eCommerce Storefronts</strong>
77
</h3>
88
<p align="center">
9-
Fully customizable, backend-agnostic with <a href="https://www.vuestorefront.io/live-projects/?utm_source=github.com&utm_medium=referral&utm_campaign=readme">
10-
2000+ Live Stores!
9+
Fully customizable, backend-agnostic with <a href="https://alokai.com/live-projects/?utm_source=github.com&utm_medium=referral&utm_campaign=readme">
10+
3500+ Live Stores!
1111
</a>
1212
</p>
1313

1414
<p align="center">
15-
<a href="https://docs.vuestorefront.io/v2/">
15+
<a href="https://docs.alokai.com/">
1616
Documentation
17-
</a> |
18-
<a href="https://demo.vuestorefront.io/">
19-
Demo Store
2017
</a>
2118
</p>
2219

@@ -28,8 +25,8 @@
2825
<a href="https://github.com/vuestorefront/vue-storefront/">
2926
<img alt="GitHub Repository Stars Count" src="https://img.shields.io/github/stars/vuestorefront/vue-storefront?style=social" />
3027
</a>
31-
<a href="https://twitter.com/vsfdevelopers">
32-
<img alt="Follow Us on Twitter" src="https://img.shields.io/twitter/follow/VSFdevelopers?style=social" />
28+
<a href="https://twitter.com/usealokai">
29+
<img alt="Follow Us on Twitter" src="https://img.shields.io/twitter/follow/useAlokai?style=social" />
3330
</a>
3431
<a href="https://www.youtube.com/c/VueStorefront">
3532
<img alt="Subscribe on our Youtube Channel" src="https://img.shields.io/youtube/channel/subscribers/UCkm1F3Cglty3CE1QwKQUhhg?style=social" />
@@ -63,41 +60,6 @@ Alokai is your guide to the composable commerce world that simplifies building,
6360

6461
- **Fully customizable**. Build your application with pre-installed [Storefront UI](https://github.com/vuestorefront/storefront-ui) - components library designed for eCommerce, or build your own theme from scratch.
6562

66-
## **Integrations** 🛍️
67-
<p align="center">
68-
<a target="_blank" href="https://docs.vuestorefront.io/v2/integrations/">Check out the integrations with eCommerce platform, CMS, payment provider, and more.</a>
69-
</p>
70-
71-
## **Getting started** 🚀
72-
Create a new Alokai project with Open Source integration in just a few steps. For the Enterprise integration, please [contact sales](https://vuestorefront.io/contact/sales).
73-
74-
### **Step 1: Generate a new project** 🧰
75-
76-
```bash
77-
npx @vue-storefront/cli generate store
78-
```
79-
80-
You will be asked to enter the project's name and select the eCommerce platform you wish to use. Once selected, the CLI will create project files in the directory matching your project name.
81-
82-
### **Step 2: Install dependencies**
83-
84-
Go to the newly created directory and install the required dependencies:
85-
86-
87-
```bash
88-
cd <project_name>
89-
90-
yarn
91-
```
92-
93-
> Alokai supports only **Yarn** package manager. If you don't have it installed, please follow the [official Yarn installation guide](https://yarnpkg.com/getting-started/install).
94-
95-
### **Step 3: Configure the project** ⚙️
96-
97-
The next step is to configure your project, and it's different for every eCommerce integration. Go to the [Integrations](https://docs.vuestorefront.io/integrations/) page, open the documentation for the integration you selected in our CLI, and look for the page describing the configuration steps.
98-
99-
Continue with the configuration steps described in the documentation for your integration.
100-
10163
## **What you get out-of-the-box** 📦
10264

10365
<p align="center">
@@ -132,36 +94,13 @@ If you have any questions about contributing, please join our [Discord server](h
13294

13395
Discovered a 🐜 or have feature suggestion? Feel free to [create an issue](https://github.com/vuestorefront/vue-storefront/issues/new/choose) on Github.
13496

135-
## **Support us** ❤️
136-
137-
**Alokai is and always will be Open Source, released under MIT Licence.**
138-
139-
How you can help us:
140-
141-
- **Contribute** - this is how the Core Team is supporting the project.
142-
- **Spread the word** - tell your friends, colleagues, and followers about Alokai.
143-
- **Create content** - write a blog post, record a video, or create a tutorial. We will be happy to share it on our social media channels.
144-
- **Engage with the community** - help others in our [Discord server](https://discord.vuestorefront.io/).
145-
146-
<a target="_blank" href="https://vuestorefront.io/developer-newsletter">Sign up to Developer's Newsletter.</a>
147-
14897
### **Follow us on Social Media**
14998

150-
[![Twitter Follow](https://img.shields.io/twitter/follow/VSFdevelopers?style=social)](https://twitter.com/VSFdevelopers)
151-
[![YouTube Follow](https://img.shields.io/badge/YouTube-Follow-black?style=social&logo=youtube)](https://www.youtube.com/c/VueStorefront)
99+
[![Twitter Follow](https://img.shields.io/twitter/follow/useAlokai?style=social)](https://twitter.com/useAlokai)
100+
[![YouTube Follow](https://img.shields.io/badge/YouTube-Follow-black?style=social&logo=youtube)](https://www.youtube.com/c/useAlokai)
152101
[![Dev.to Follow](https://img.shields.io/badge/DEV.to-Follow-black?style=social&logo=dev.to)](https://dev.to/vue-storefront)
153102
[![LinkedIn Follow](https://img.shields.io/badge/LinkedIn-Follow-black?style=social&logo=linkedin)](https://www.linkedin.com/company/vue-storefront/)
154-
[![Facebook Follow](https://img.shields.io/badge/Facebook-Follow-black?style=social&logo=facebook)](https://www.facebook.com/vuestorefront)
155-
156-
## **Partners** 💪
157-
158-
Alokai is a Community effort brought to You by our great Core Team and supported by the following companies.
159-
160-
[**See Alokai partners directory**](https://www.vuestorefront.io/partner-agencies?utm_source=github.com&utm_medium=referral&utm_campaign=readme)
161-
162-
Alokai source code is completely free and released under the [MIT License](https://github.com/vuestorefront/vue-storefront/blob/master/LICENSE).
163103

164-
[![analytics](http://www.google-analytics.com/collect?v=1&t=pageview&_s=1&dl=https%3A%2F%2Fgithub.com%2FDivanteLtd%2Fvue-storefront&_u=MAC~&cid=1757014354.1393964045&tid=UA-108235765-10)]()
165104
## **Careers** 👩‍💻👨‍💻
166105

167106
We are growing and we are looking for talented people to join our team. If you are interested in working with us, please check our [Careers page](https://vuestorefront.io/careers).

0 commit comments

Comments
 (0)